npm - @openfin/core-web - Versions diffs - 0.40.11 → 0.40.13 - Mend

@openfin/core-web 0.40.11 → 0.40.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

package/out/docs/documents/OpenFin_Web_Application_Developer_Guide.html ADDED Viewed

@@ -0,0 +1,43 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OpenFin Web Application Developer Guide | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="OpenFin_Web_Application_Developer_Guide.html">OpenFin Web Application Developer Guide</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="md:openfin-web-application-developer-guide" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Openfin Web Application Developer Guide<a href="#md:openfin-web-application-developer-guide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>If you are a developer who is building contentful applications which use the OpenFin APIs, the default entry point of this package provides a <code>connect</code> function. This is designed to complement the type definitions found in <a href="https://www.npmjs.com/package/@openfin/core">@openfin/core</a>.</p>
+<p>Note - if you are a platform developer looking to setup an OpenFin Web Interop Broker, please check out <a href="Platform_Developer_Guide.html">this guide</a>.</p>
+<a id="md:first-steps" class="tsd-anchor"></a><h2 class="tsd-anchor-link">First Steps<a href="#md:first-steps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>To install <code>@openfin/core-web</code>, run the following command:</p>
+<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@openfin/core-web</span><span class="hl-1"> </span><span class="hl-3">-S</span>
+</code><button type="button">Copy</button></pre>
+<p>We recommend using <code>@openfin/core-web</code> with a modern build tool like Next.js, Webpack or Vite.</p>
+<p>It is framework agnostic, meaning it should work with any UI framework.</p>
+<a id="md:connecting-to-a-web-broker" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Connecting to a Web Broker<a href="#md:connecting-to-a-web-broker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>An <code>@openfin/core-web</code> Web Broker is a piece of hosted infrastructure which you can connect to from a web site in order to interact with other content connected to the same Web Broker. A Web Broker is responsible for deciding whether you can connect to it, and connecting you to other applications via OpenFin's Interop and Channels APIs.</p>
+<p>When the Web Broker url is known, connecting to a specific <code>@openfin/core-web</code> broker will return a fin connection.</p>
+<a id="md:example-basic-connection-setup" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Basic Connection Setup<a href="#md:example-basic-connection-setup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">connect</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@openfin/core-web&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">brokerUrl</span><span class="hl-1"> = </span><span class="hl-2">&#39;http://example.com/web-broker&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-1">(</span><span class="hl-3">async</span><span class="hl-1"> () </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-7">// Connect to the OpenFin Web Broker.</span><br/><span class="hl-1">    </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">fin</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">connect</span><span class="hl-1">({ </span><span class="hl-5">options:</span><span class="hl-1"> { </span><span class="hl-5">brokerUrl</span><span class="hl-1"> } });</span><br/><br/><span class="hl-1">    </span><span class="hl-7">// You may now use the `fin` object. In this case, we connect to a channel.</span><br/><span class="hl-1">    </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">channelClient</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-5">fin</span><span class="hl-1">.</span><span class="hl-5">InterapplicationBus</span><span class="hl-1">.</span><span class="hl-5">Channel</span><span class="hl-1">.</span><span class="hl-0">connect</span><span class="hl-1">(</span><span class="hl-2">&#39;some channel name&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">})();</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:setting-a-timeout" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Setting a Timeout<a href="#md:setting-a-timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>If desired, the timeout option (in milliseconds) can be specified to abandon the connection after a set amount of time.</p>
+<p>An example below shows setting up a 30 second timeout.</p>
+<a id="md:example-setting-a-timeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Setting a Timeout<a href="#md:example-setting-a-timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-7">// This connect call will throw if a connection is not established within 30 seconds.</span><br/><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">connect</span><span class="hl-1">({ </span><span class="hl-5">options:</span><span class="hl-1"> { </span><span class="hl-5">brokerUrl</span><span class="hl-1">, </span><span class="hl-5">timeout:</span><span class="hl-1"> </span><span class="hl-8">30000</span><span class="hl-1"> } });</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:setting-up-an-interop-connection" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Setting up an Interop Connection<a href="#md:setting-up-an-interop-connection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>An Interop connection can be configured in order to automatically set up an interop client. This client may be accessed via the <code>fin.me.interop</code> namespace.</p>
+<p>A Provider ID must be specified for the <code>fin.me.interop</code> client to work if <code>connectionInheritance</code> is not supported. An example is shown below:</p>
+<a id="md:example-connecting-to-an-interop-broker" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Connecting to an Interop Broker<a href="#md:example-connecting-to-an-interop-broker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-7">// Specify an interopConfig with a specific provider ID to initialize the `fin.me.interop` client on connection.</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">fin</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">connect</span><span class="hl-1">({ </span><span class="hl-5">options:</span><span class="hl-1"> { </span><span class="hl-5">brokerUrl</span><span class="hl-1">, </span><span class="hl-5">interopConfig:</span><span class="hl-1"> { </span><span class="hl-5">providerId:</span><span class="hl-1"> </span><span class="hl-2">&#39;provider-id&#39;</span><span class="hl-1"> } } });</span><br/><br/><span class="hl-7">// fin.me.interop is an InteropClient connected to the `provider-id` InteropBroker.</span><br/><span class="hl-5">fin</span><span class="hl-1">.</span><span class="hl-5">me</span><span class="hl-1">.</span><span class="hl-5">interop</span><span class="hl-1">.</span><span class="hl-0">addContextHandler</span><span class="hl-1">((</span><span class="hl-5">context</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&#39;received context&#39;</span><span class="hl-1">));</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:specifying-an-initial-context-group" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Specifying an Initial Context Group<a href="#md:specifying-an-initial-context-group" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>By default OpenFin's Interop Client api does not select a context group. The following example illustrates setting up an initial context group during connection.</p>
+<a id="md:example-joining-a-default-context-group" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Joining a Default Context Group<a href="#md:example-joining-a-default-context-group" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-7">// Specify an interopConfig with a specific provider ID and a context group to initialize the `fin.me.interop` client on connection.</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">fin</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">connect</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-5">options:</span><span class="hl-1"> { </span><span class="hl-5">brokerUrl</span><span class="hl-1">, </span><span class="hl-5">interopConfig:</span><span class="hl-1"> { </span><span class="hl-5">providerId:</span><span class="hl-1"> </span><span class="hl-2">&#39;provider-id&#39;</span><span class="hl-1">, </span><span class="hl-5">currentContextGroup:</span><span class="hl-1"> </span><span class="hl-2">&#39;red&#39;</span><span class="hl-1"> } }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-7">// The fin.me.interop client adds a context handler which will receive updates published on the `red` context group.</span><br/><span class="hl-5">fin</span><span class="hl-1">.</span><span class="hl-5">me</span><span class="hl-1">.</span><span class="hl-5">interop</span><span class="hl-1">.</span><span class="hl-0">addContextHandler</span><span class="hl-1">((</span><span class="hl-5">context</span><span class="hl-1">) </span><span class="hl-3">=&gt;</span><span class="hl-1"> </span><span class="hl-5">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">&#39;received context&#39;</span><span class="hl-1">));</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:initializing-fdc3" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Initializing FDC3<a href="#md:initializing-fdc3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This library does not produce any global variables. To leverage FDC3 you may use the <code>.getFDC3</code> or <code>.getFDC3Sync</code> apis of a connected <code>InteropClient</code>. (Note that with an interop config provided in <code>connect</code> <code>fin.me.interop</code> is instantiated as an <code>InteropClient</code>)</p>
+<p>Supported versions for <code>fdc3</code> are <code>1.2</code> or <code>2.0</code>.</p>
+<a id="md:example-creating-an-fdc3-client" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Creating an FDC3 Client<a href="#md:example-creating-an-fdc3-client" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">connect</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@openfin/core-web&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">brokerUrl</span><span class="hl-1"> = </span><span class="hl-2">&#39;http://example.com/web-broker&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-7">// Specify an interopConfig with a specific provider ID and a context group to initialize the `fin.me.interop` client on connection.</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">fin</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">connect</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-5">options:</span><span class="hl-1"> { </span><span class="hl-5">brokerUrl</span><span class="hl-1">, </span><span class="hl-5">interopConfig:</span><span class="hl-1"> { </span><span class="hl-5">providerId:</span><span class="hl-1"> </span><span class="hl-2">&#39;provider-id&#39;</span><span class="hl-1">, </span><span class="hl-5">currentContextGroup:</span><span class="hl-1"> </span><span class="hl-2">&#39;red&#39;</span><span class="hl-1"> } }</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-7">// Set window.fdc3 to an FDC3 2.0 DesktopAgent which is connected to the `provider-id` InteropBroker on the `red&#39; channel.</span><br/><span class="hl-5">window</span><span class="hl-1">.</span><span class="hl-5">fdc3</span><span class="hl-1"> = </span><span class="hl-5">fin</span><span class="hl-1">.</span><span class="hl-5">me</span><span class="hl-1">.</span><span class="hl-5">interop</span><span class="hl-1">.</span><span class="hl-0">getFDC3Sync</span><span class="hl-1">(</span><span class="hl-2">&#39;2.0&#39;</span><span class="hl-1">);</span>
+</code><button type="button">Copy</button></pre>
+<p>Note that FDC3 support in web is currently limited to context sharing on system channels.</p>
+<a id="md:context-aware-connections-and-connection-inheritance" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Context Aware Connections and Connection Inheritance<a href="#md:context-aware-connections-and-connection-inheritance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p><code>@openfin/core-web</code> has been designed to support inheritance of brokerUrls and interop configurations if your content is running as a View within an OpenFin Layout. This allows content developers to develop platform-agnostic experiences and ensure that they are able to interact with other content connected to the same Web Broker.</p>
+<a id="md:api-reference" class="tsd-anchor"></a><h2 class="tsd-anchor-link">API Reference<a href="#md:api-reference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>(Please note, this link works in your IDE and not on <a href="http://npmjs.com">npmjs.com</a>, we will update this soon.)</p>
+<ul>
+<li><a href="../out/docs/@openfin/core-web/README.md">@openfin/core-web</a></li>
+</ul>
+<a id="md:see-also" class="tsd-anchor"></a><h2 class="tsd-anchor-link">See Also<a href="#md:see-also" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
+<li><a href="https://developer.openfin.co/docs/javascript/stable">Fin API reference</a></li>
+<li><a href="https://developers.openfin.co/of-docs/docs/container-overview">OpenFin Container Developer guide</a></li>
+</ul>
+</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:openfin-web-application-developer-guide"><span>Openfin <wbr/>Web <wbr/>Application <wbr/>Developer <wbr/>Guide</span></a><ul><li><a href="#md:first-steps"><span>First <wbr/>Steps</span></a></li><li><a href="#md:connecting-to-a-web-broker"><span>Connecting to a <wbr/>Web <wbr/>Broker</span></a></li><li><ul><li><a href="#md:example-basic-connection-setup"><span>Example: <wbr/>Basic <wbr/>Connection <wbr/>Setup</span></a></li></ul></li><li><a href="#md:setting-a-timeout"><span>Setting a <wbr/>Timeout</span></a></li><li><ul><li><a href="#md:example-setting-a-timeout"><span>Example: <wbr/>Setting a <wbr/>Timeout</span></a></li></ul></li><li><a href="#md:setting-up-an-interop-connection"><span>Setting up an <wbr/>Interop <wbr/>Connection</span></a></li><li><ul><li><a href="#md:example-connecting-to-an-interop-broker"><span>Example: <wbr/>Connecting to an <wbr/>Interop <wbr/>Broker</span></a></li></ul></li><li><a href="#md:specifying-an-initial-context-group"><span>Specifying an <wbr/>Initial <wbr/>Context <wbr/>Group</span></a></li><li><ul><li><a href="#md:example-joining-a-default-context-group"><span>Example: <wbr/>Joining a <wbr/>Default <wbr/>Context <wbr/>Group</span></a></li></ul></li><li><a href="#md:initializing-fdc3"><span>Initializing FDC3</span></a></li><li><ul><li><a href="#md:example-creating-an-fdc3-client"><span>Example: <wbr/>Creating an FDC3 <wbr/>Client</span></a></li></ul></li><li><a href="#md:context-aware-connections-and-connection-inheritance"><span>Context <wbr/>Aware <wbr/>Connections and <wbr/>Connection <wbr/>Inheritance</span></a></li><li><a href="#md:api-reference"><span>API <wbr/>Reference</span></a></li><li><a href="#md:see-also"><span>See <wbr/>Also</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/documents/Platform_Developer_Guide.html ADDED Viewed

@@ -0,0 +1,75 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Platform Developer Guide | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="Platform_Developer_Guide.html">Platform Developer Guide</a></li></ul></div><div class="tsd-panel tsd-typography"><a id="md:platform-developer-guide" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Platform Developer Guide<a href="#md:platform-developer-guide" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h1><p>If you are a Platform owner who wants to include OpenFin's web capabilities in your platform, there are a few steps required. This section will guide you through the process of setting up an environment. Please note, none of these steps are necessary for content developers (See the <a href="OpenFin_Web_Application_Developer_Guide.html">content developer guide</a>).</p>
+<a id="md:first-steps" class="tsd-anchor"></a><h2 class="tsd-anchor-link">First Steps<a href="#md:first-steps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Ensure that <code>@openfin/core-web</code> is installed by running the following command:</p>
+<pre><code class="bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">i</span><span class="hl-1"> </span><span class="hl-2">@openfin/core-web</span><span class="hl-1"> </span><span class="hl-3">-S</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:host-the-openfincore-web-shared-worker" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Host the <code>@openfin/core-web</code> Shared Worker<a href="#md:host-the-openfincore-web-shared-worker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>An <code>@openfin/core-web/shared-worker</code> entry point is included in this package's distribution. This is a non-customizable, standalone piece of javascript that must be hosted on your server for <code>@openfin/core-web</code> to function.</p>
+<p>This file has already been bundled, which means you just need to host it on a web server on a known URL.</p>
+<a id="md:build-a-web-broker" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Build a Web Broker<a href="#md:build-a-web-broker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>An HTML page, loaded as a hidden iframe by clients, must be hosted in the same origin as the <code>@openfin/shared-worker</code>. This iframe acts as a gatekeeper to the <code>shared-worker</code> and therefore must be hosted on the same domain.</p>
+<p>In order to build a Web Broker, the following requirements must be met:</p>
+<ol>
+<li>
+<p>You must host the <code>@openfin/core-web/shared-worker</code> bundle on a domain (for example <a href="https://www.example.com/mysharedworker.js">https://www.example.com/mysharedworker.js</a>).</p>
+</li>
+<li>
+<p>You must host a web broker page on that same domain (for example, <a href="https://www.example.com/web-broker">https://www.example.com/web-broker</a>).</p>
+</li>
+<li>
+<p>That page must call <code>init</code> from <code>@openfin/core-web/iframe-broker</code> with the URL of the shared worker hosted in step 1.</p>
+<pre><code class="typescript"><span class="hl-7">// Runs on https://www.example.com/web-broker</span><br/><span class="hl-4">import</span><span class="hl-1"> {</span><span class="hl-5">init</span><span class="hl-1">} </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@openfin/core-web/iframe-broker</span><span class="hl-9">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">sharedWorkerUrl</span><span class="hl-1"> = </span><span class="hl-2">&#39;https://www.example.com/mysharedworker.js&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">init</span><span class="hl-1">({</span><span class="hl-5">sharedWorkerUrl</span><span class="hl-1">})</span>
+</code><button type="button">Copy</button></pre>
+</li>
+</ol>
+<p>Here is a basic example of hosting a Web Broker:</p>
+<a id="md:example-set-up-a-basic-web-broker" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Set up a Basic Web Broker<a href="#md:example-set-up-a-basic-web-broker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>First, host <code>@openfin/core-web/shared-worker</code> at <code>/openfin-shared-worker.js</code></p>
+<p>File: iframe-broker.html</p>
+<pre><code class="html"><span class="hl-10">&lt;</span><span class="hl-11">html</span><span class="hl-10">&gt;</span><br/><span class="hl-1">    </span><span class="hl-10">&lt;</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-1">        </span><span class="hl-10">&lt;</span><span class="hl-11">script</span><span class="hl-12"> </span><span class="hl-13">src</span><span class="hl-12">=</span><span class="hl-14">&quot;iframe-broker.js&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">script</span><span class="hl-10">&gt;</span><br/><span class="hl-1">    </span><span class="hl-10">&lt;/</span><span class="hl-11">body</span><span class="hl-10">&gt;</span><br/><span class="hl-10">&lt;/</span><span class="hl-11">html</span><span class="hl-10">&gt;</span>
+</code><button type="button">Copy</button></pre>
+<p>File: iframe-broker.js</p>
+<pre><code class="typescript"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">init</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@openfin/core-web/iframe-broker&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">init</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-5">sharedWorkerUrl:</span><span class="hl-1"> </span><span class="hl-2">`</span><span class="hl-3">${</span><span class="hl-5">location</span><span class="hl-12">.</span><span class="hl-5">origin</span><span class="hl-3">}</span><span class="hl-2">/openfin-shared-worker.js`</span><br/><span class="hl-1">});</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:reject-connections" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Reject Connections<a href="#md:reject-connections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>As an owner of an Iframe Broker, you should first rely on existing web security tools such as the frame-ancestors CSP rule to prevent content from connecting to you which you don't expect.</p>
+<p><code>@openfin/core-web</code> exposes a <code>rejectConnections</code> utility if you wish to implement custom rejection logic. If neither <code>init</code> or <code>rejectConnection</code> is invoked, an embedding client may hang indefinitely.</p>
+<a id="md:example-reject-a-cross-origin-connection-using-openfincore-webiframe-broker" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Reject a Cross Origin Connection using <code>@openfin/core-web/iframe-broker</code><a href="#md:example-reject-a-cross-origin-connection-using-openfincore-webiframe-broker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">init</span><span class="hl-1">, </span><span class="hl-5">rejectConnections</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@openfin/core-web/iframe-broker&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-7">// If the origins do not match.</span><br/><span class="hl-4">if</span><span class="hl-1"> (</span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">URL</span><span class="hl-1">(</span><span class="hl-5">document</span><span class="hl-1">.</span><span class="hl-5">referrer</span><span class="hl-1">).</span><span class="hl-5">origin</span><span class="hl-1"> !== </span><span class="hl-5">location</span><span class="hl-1">.</span><span class="hl-5">origin</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-0">rejectConnections</span><span class="hl-1">({</span><br/><span class="hl-1">        </span><span class="hl-5">reason:</span><span class="hl-1"> </span><span class="hl-2">&#39;Connections from this domain are not supported&#39;</span><span class="hl-1"> </span><span class="hl-7">// Reason allows an error to be returned to the connecting client.</span><br/><span class="hl-1">    });</span><br/><span class="hl-1">} </span><span class="hl-4">else</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-0">init</span><span class="hl-1">({</span><br/><span class="hl-1">        </span><span class="hl-5">sharedWorkerUrl:</span><span class="hl-1"> </span><span class="hl-2">`</span><span class="hl-3">${</span><span class="hl-5">location</span><span class="hl-12">.</span><span class="hl-5">origin</span><span class="hl-3">}</span><span class="hl-2">/openfin-shared-worker.js`</span><br/><span class="hl-1">    });</span><br/><span class="hl-1">}</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:experimental-enable-cross-tab-support" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Experimental: Enable Cross Tab Support<a href="#md:experimental-enable-cross-tab-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>By default, <code>@openfin/core-web</code> disables the sharing of connections across browser Tabs. However, this feature may be enabled by specifying the following flag in an IFrame Broker:</p>
+<a id="md:example-enable-cross-tab-support" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Enable Cross Tab Support<a href="#md:example-enable-cross-tab-support" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><pre><code class="typescript"><span class="hl-0">init</span><span class="hl-1">({</span><br/><span class="hl-1">    </span><span class="hl-5">sharedWorkerUrl:</span><span class="hl-1"> </span><span class="hl-2">`</span><span class="hl-3">${</span><span class="hl-5">location</span><span class="hl-12">.</span><span class="hl-5">origin</span><span class="hl-3">}</span><span class="hl-2">/openfin-shared-worker.js`</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-5">experimental:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-5">crossTab:</span><span class="hl-1"> </span><span class="hl-2">&#39;same-site&#39;</span><br/><span class="hl-1">    }</span><br/><span class="hl-1">});</span>
+</code><button type="button">Copy</button></pre>
+<a id="md:create-layouts" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Create Layouts<a href="#md:create-layouts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Layouts in the web are very similar to the desktop OpenFin environment. They consist of a layout configuration that describes the rows/columns/view components. The major difference is that the <code>layout</code> key is not supported. Instead, we expose the <code>layoutSnapshot</code> key to plug into the multiple-layout architecture. See the <a href="https://developers.openfin.co/of-docs/docs/multi-layouts">Multi-Layout guide</a> for more information on how to set it up.</p>
+<p>Note that you can achieve a single layout by having only 1 key in your <code>layoutSnapshot</code>:</p>
+<pre><code class="typescript"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">layoutSnapshot</span><span class="hl-1"> = {</span><br/><span class="hl-1">    </span><span class="hl-5">layouts:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-5">layout:</span><span class="hl-1"> { ... }</span><br/><span class="hl-1">    }</span><br/><span class="hl-1">}</span>
+</code><button type="button">Copy</button></pre>
+<p>The JSON structure of the underlying layout options is interchangeable, though not identical, between Desktop and Web. Web Layout Snapshots have an optional <code>web</code> property within the view <code>componentState</code> options which stores web specific properties. This <code>web</code> property is ignored on desktop.</p>
+<a id="md:layout-settings" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Layout Settings<a href="#md:layout-settings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Layouts in the web support the following <a href="https://cdn.openfin.co/docs/javascript/stable/interfaces/OpenFin.LayoutOptions.html#settings"><code>LayoutOptions.settings</code></a>:</p>
+<ul>
+<li><code>reorderEnabled</code> (Default value <strong>true</strong>): If true, users can re-arrange the layout by dragging items by their tabs to the desired location. Note, unlike in an OpenFin environment the dragging of items is limited to the current window.</li>
+<li><code>hasHeaders</code> (Default value <strong>true</strong>): Turns tab headers on or off. If false, the layout will be displayed with splitters only.</li>
+<li><code>preventSplitterResize</code> (Default value <strong>false</strong>): When true the splitters will not be draggable and the layout will not resize.</li>
+</ul>
+<a id="md:example-retrieve-a-layoutsnapshot-from-both-desktop-and-web-environments" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Retrieve a layoutSnapshot from both desktop and web environments<a href="#md:example-retrieve-a-layoutsnapshot-from-both-desktop-and-web-environments" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>From within your OpenFin v34+ Desktop environment, retrieve the current layoutSnapshot:</p>
+<pre><code class="typescript"><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">layoutManager</span><span class="hl-1"> = </span><span class="hl-5">fin</span><span class="hl-1">.</span><span class="hl-5">Platform</span><span class="hl-1">.</span><span class="hl-5">Layout</span><span class="hl-1">.</span><span class="hl-0">getCurrentLayoutManagerSync</span><span class="hl-1">();</span><br/><span class="hl-7">// returns an object like: { layouts: { ... } } where each key in layouts.&lt;key&gt; is it&#39;s own separate layout configuration</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">layoutSnapshot</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-5">layoutManager</span><span class="hl-1">.</span><span class="hl-0">getLayoutSnapshot</span><span class="hl-1">();</span>
+</code><button type="button">Copy</button></pre>
+<p>Note that the <code>fin.Platform.Layout</code> API is exactly the same in web, so you can retrieve the Web Layout Snapshot using the same code.</p>
+<a id="md:example-create-a-layoutsnapshot-with-2-layouts-and-initialize-it-via-connect-call" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Example: Create a layoutSnapshot with 2 layouts and initialize it via connect call<a href="#md:example-create-a-layoutsnapshot-with-2-layouts-and-initialize-it-via-connect-call" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><p>In order to use layouts, specify the <code>platform</code> option to the <code>connect</code> call and pass in the <code>layoutSnapshot</code>.</p>
+<pre><code class="typescript"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">connect</span><span class="hl-1">, </span><span class="hl-4">type</span><span class="hl-1"> </span><span class="hl-5">WebLayoutSnapshot</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@openfin/core-web&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">brokerUrl</span><span class="hl-1"> = </span><span class="hl-2">&#39;http://example.com/web-broker&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-7">// Presumably retrieved from fin.Platform.Layout.getCurrentLayoutManagerSync().getLayoutSnapshot()</span><br/><span class="hl-7">// in a v34+ Desktop environment, but also can be manually constructed like this:</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">layoutSnapshot</span><span class="hl-1">: </span><span class="hl-15">WebLayoutSnapshot</span><span class="hl-1"> = {</span><br/><span class="hl-1">    </span><span class="hl-5">layouts:</span><span class="hl-1"> {</span><br/><span class="hl-1">        </span><span class="hl-5">tab1:</span><span class="hl-1"> {</span><br/><span class="hl-1">            </span><span class="hl-5">content:</span><span class="hl-1"> [</span><br/><span class="hl-1">                {</span><br/><span class="hl-1">                    </span><span class="hl-5">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;row&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                    </span><span class="hl-5">content:</span><span class="hl-1"> [</span><br/><span class="hl-1">                        {</span><br/><span class="hl-1">                            </span><span class="hl-5">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;stack&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                            </span><span class="hl-5">content:</span><span class="hl-1"> [</span><br/><span class="hl-1">                                {</span><br/><span class="hl-1">                                    </span><span class="hl-5">title:</span><span class="hl-1"> </span><span class="hl-2">&#39;Example&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                                    </span><span class="hl-5">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;component&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                                    </span><span class="hl-5">componentName:</span><span class="hl-1"> </span><span class="hl-2">&#39;view&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                                    </span><span class="hl-5">componentState:</span><span class="hl-1"> {</span><br/><span class="hl-1">                                        </span><span class="hl-5">url:</span><span class="hl-1"> </span><span class="hl-2">&#39;http://example.com/&#39;</span><br/><span class="hl-1">                                    }</span><br/><span class="hl-1">                                }</span><br/><span class="hl-1">                            ]</span><br/><span class="hl-1">                        },</span><br/><span class="hl-1">                        {</span><br/><span class="hl-1">                            </span><span class="hl-5">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;stack&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                            </span><span class="hl-5">content:</span><span class="hl-1"> [</span><br/><span class="hl-1">                                {</span><br/><span class="hl-1">                                    </span><span class="hl-5">title:</span><span class="hl-1"> </span><span class="hl-2">&#39;Example&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                                    </span><span class="hl-5">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;component&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                                    </span><span class="hl-5">componentName:</span><span class="hl-1"> </span><span class="hl-2">&#39;view&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                                    </span><span class="hl-5">componentState:</span><span class="hl-1"> {</span><br/><span class="hl-1">                                        </span><span class="hl-5">url:</span><span class="hl-1"> </span><span class="hl-2">&#39;http://example.com/&#39;</span><br/><span class="hl-1">                                    }</span><br/><span class="hl-1">                                }</span><br/><span class="hl-1">                            ]</span><br/><span class="hl-1">                        }</span><br/><span class="hl-1">                    ]</span><br/><span class="hl-1">                }</span><br/><span class="hl-1">            ]</span><br/><span class="hl-1">        },</span><br/><span class="hl-1">        </span><span class="hl-5">tab2:</span><span class="hl-1"> {</span><br/><span class="hl-1">            </span><span class="hl-5">content:</span><span class="hl-1"> [</span><br/><span class="hl-1">                {</span><br/><span class="hl-1">                    </span><span class="hl-5">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;stack&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                    </span><span class="hl-5">content:</span><span class="hl-1"> [</span><br/><span class="hl-1">                        {</span><br/><span class="hl-1">                            </span><span class="hl-5">title:</span><span class="hl-1"> </span><span class="hl-2">&#39;Example&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                            </span><span class="hl-5">type:</span><span class="hl-1"> </span><span class="hl-2">&#39;component&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                            </span><span class="hl-5">componentName:</span><span class="hl-1"> </span><span class="hl-2">&#39;view&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">                            </span><span class="hl-5">componentState:</span><span class="hl-1"> {</span><br/><span class="hl-1">                                </span><span class="hl-5">url:</span><span class="hl-1"> </span><span class="hl-2">&#39;http://example.com/&#39;</span><br/><span class="hl-1">                            }</span><br/><span class="hl-1">                        }</span><br/><span class="hl-1">                    ]</span><br/><span class="hl-1">                }</span><br/><span class="hl-1">            ]</span><br/><span class="hl-1">        }</span><br/><span class="hl-1">    }</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-1">(</span><span class="hl-3">async</span><span class="hl-1"> () </span><span class="hl-3">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">    </span><span class="hl-7">// Connect to the OpenFin Web Broker. Pass in the `platform` key with a layoutSnapshot.</span><br/><span class="hl-1">    </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">fin</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">connect</span><span class="hl-1">({</span><br/><span class="hl-1">        </span><span class="hl-5">connectionInheritance:</span><span class="hl-1"> </span><span class="hl-2">&#39;enabled&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">        </span><span class="hl-5">options:</span><span class="hl-1"> { </span><span class="hl-5">brokerUrl</span><span class="hl-1"> },</span><br/><span class="hl-1">        </span><span class="hl-5">platform:</span><span class="hl-1"> { </span><span class="hl-5">layoutSnapshot</span><span class="hl-1"> }</span><br/><span class="hl-1">    });</span><br/><br/><span class="hl-1">    </span><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">container</span><span class="hl-1"> = </span><span class="hl-5">document</span><span class="hl-1">.</span><span class="hl-0">getElementById</span><span class="hl-1">(</span><span class="hl-2">&#39;layout-container&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1">    </span><span class="hl-7">// You may now use the `fin` object. In this case, we want to initialize and create layouts.</span><br/><span class="hl-1">    </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-5">fin</span><span class="hl-1">.</span><span class="hl-5">Platform</span><span class="hl-1">.</span><span class="hl-5">Layout</span><span class="hl-1">.</span><span class="hl-0">init</span><span class="hl-1">({ </span><span class="hl-5">container</span><span class="hl-1"> });</span><br/><br/><span class="hl-1">    </span><span class="hl-7">// For multi-layout information see https://developers.openfin.co/of-docs/docs/multi-layouts</span><br/><span class="hl-1">    </span><span class="hl-7">// In the multi-layout case we would also call `fin.Platform.Layout.create()`.</span><br/><span class="hl-1">})();</span>
+</code><button type="button">Copy</button></pre>
+<p>Note that cross-tab support is experimental, browser-dependent and respects each browser's privacy sandbox.</p>
+<a id="md:api-reference" class="tsd-anchor"></a><h2 class="tsd-anchor-link">API Reference<a href="#md:api-reference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>(Please note, these links work in your IDE and not on <a href="http://npmjs.com">npmjs.com</a>, we will update this soon.)</p>
+<ul>
+<li><a href="../out/docs/@openfin/core-web/README.md">@openfin/core-web</a></li>
+<li><a href="../out/docs/@openfin/core-web/iframe-broker/README.md">@openfin/core-web/iframe-broker</a></li>
+<li><a href="../out/docs/@openfin/core-web/shared-worker/README.md">@openfin/core-web/shared-worker</a></li>
+</ul>
+<a id="md:see-also" class="tsd-anchor"></a><h2 class="tsd-anchor-link">See Also<a href="#md:see-also" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><ul>
+<li><a href="https://developers.openfin.co/of-docs/docs/container-overview">OpenFin Container Developer guide</a></li>
+<li><a href="https://developer.openfin.co/docs/javascript/stable">Fin API reference</a></li>
+</ul>
+</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:platform-developer-guide"><span>Platform <wbr/>Developer <wbr/>Guide</span></a><ul><li><a href="#md:first-steps"><span>First <wbr/>Steps</span></a></li><li><ul><li><a href="#md:host-the-openfincore-web-shared-worker"><span>Host the @openfin/core-<wbr/>web <wbr/>Shared <wbr/>Worker</span></a></li></ul></li><li><a href="#md:build-a-web-broker"><span>Build a <wbr/>Web <wbr/>Broker</span></a></li><li><ul><li><a href="#md:example-set-up-a-basic-web-broker"><span>Example: <wbr/>Set up a <wbr/>Basic <wbr/>Web <wbr/>Broker</span></a></li></ul></li><li><a href="#md:reject-connections"><span>Reject <wbr/>Connections</span></a></li><li><ul><li><a href="#md:example-reject-a-cross-origin-connection-using-openfincore-webiframe-broker"><span>Example: <wbr/>Reject a <wbr/>Cross <wbr/>Origin <wbr/>Connection using @openfin/core-<wbr/>web/iframe-<wbr/>broker</span></a></li></ul></li><li><a href="#md:experimental-enable-cross-tab-support"><span>Experimental: <wbr/>Enable <wbr/>Cross <wbr/>Tab <wbr/>Support</span></a></li><li><ul><li><a href="#md:example-enable-cross-tab-support"><span>Example: <wbr/>Enable <wbr/>Cross <wbr/>Tab <wbr/>Support</span></a></li></ul></li><li><a href="#md:create-layouts"><span>Create <wbr/>Layouts</span></a></li><li><ul><li><a href="#md:layout-settings"><span>Layout <wbr/>Settings</span></a></li><li><a href="#md:example-retrieve-a-layoutsnapshot-from-both-desktop-and-web-environments"><span>Example: <wbr/>Retrieve a layout<wbr/>Snapshot from both desktop and web environments</span></a></li><li><a href="#md:example-create-a-layoutsnapshot-with-2-layouts-and-initialize-it-via-connect-call"><span>Example: <wbr/>Create a layout<wbr/>Snapshot with 2 layouts and initialize it via connect call</span></a></li></ul></li><li><a href="#md:api-reference"><span>API <wbr/>Reference</span></a></li><li><a href="#md:see-also"><span>See <wbr/>Also</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/functions/_openfin_core_web.connect.html ADDED Viewed

@@ -0,0 +1,18 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>connect | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="../modules/_openfin_core_web.html">@openfin/core-web</a></li><li><a href="_openfin_core_web.connect.html">connect</a></li></ul><h1>Function connect</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><a id="md:connectconnectconfig-connectconfig" class="tsd-anchor"></a><h2 class="tsd-anchor-link">connect(connectConfig: ConnectConfig)<a href="#md:connectconnectconfig-connectconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Establishes a connection to an OpenFin Web Interop Broker, returning a fin object that supports a subset of APIS.</p>
+<a id="md:supported-apis" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Supported APIs<a href="#md:supported-apis" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul>
+<li>fin.InterApplicationBus.Channels</li>
+<li>fin.Interop</li>
+<li>fin.me.identity</li>
+<li>fin.Platform.Layout.init</li>
+<li>fin.Platform.Layout.create</li>
+<li>fin.Platform.Layout.destroy</li>
+<li>fin.Platform.Layout.getCurrentLayoutManagerSync</li>
+</ul>
+</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Throws" class="tsd-anchor"></a>Throws<a href="#Throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the connection to the broker fails.</p>
+<h4 class="tsd-anchor-link"><a id="Throws-1" class="tsd-anchor"></a>Throws<a href="#Throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the connection elapses the configured timeout</p>
+<h4 class="tsd-anchor-link"><a id="Throws-2" class="tsd-anchor"></a>Throws<a href="#Throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If the provided InheritModeConnectConfig.validateOptions returns false</p>
+<h4 class="tsd-anchor-link"><a id="Throws-3" class="tsd-anchor"></a>Throws<a href="#Throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If connection inheritance is enabled but the current browsing context is not rendered as a View within an OpenFin WebLayout and no ConnectConfig.options are provided.</p>
+<h4 class="tsd-anchor-link"><a id="Throws-4" class="tsd-anchor"></a>Throws<a href="#Throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>If a platform object is provided but the layoutSnapshot is invalid.</p>
+</div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="connect" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectConfig</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Fin</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;external connection&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">connectConfig</span>: <a href="../types/_openfin_core_web.ConnectConfig.html" class="tsd-signature-type tsd-kind-type-alias">ConnectConfig</a></span><div class="tsd-comment tsd-typography"><p>Config used to initialise the connection</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Fin</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">&quot;external connection&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>Fin api object</p>
+<div class="tsd-comment tsd-typography"></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:connectconnectconfig-connectconfig"><span>connect(connect<wbr/>Config: <wbr/>Connect<wbr/>Config)</span></a><ul><li><a href="#md:supported-apis"><span>Supported APIs</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/functions/_openfin_core_web_iframe_broker.init.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>init | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="../modules/_openfin_core_web_iframe_broker.html">@openfin/core-web/iframe-broker</a></li><li><a href="_openfin_core_web_iframe_broker.init.html">init</a></li></ul><h1>Function init</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="init" class="tsd-anchor"></a><span class="tsd-kind-call-signature">init</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#init" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/_openfin_core_web_iframe_broker.ConnectionOptions.html" class="tsd-signature-type tsd-kind-type-alias">ConnectionOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/functions/_openfin_core_web_iframe_broker.rejectConnections.html ADDED Viewed

@@ -0,0 +1 @@

+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>rejectConnections | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="../modules/_openfin_core_web_iframe_broker.html">@openfin/core-web/iframe-broker</a></li><li><a href="_openfin_core_web_iframe_broker.rejectConnections.html">rejectConnections</a></li></ul><h1>Function rejectConnections</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="rejectConnections" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reject<wbr/>Connections</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#rejectConnections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">reason</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">reason</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/index.html ADDED Viewed

@@ -0,0 +1,6 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>@openfin/core-web</h2></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Modules</h3><div class="tsd-index-list"><a href="modules/_openfin_core_web.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg><span>@openfin/core-<wbr/>web</span></a>
+<a href="modules/_openfin_core_web_iframe_broker.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg><span>@openfin/core-<wbr/>web/iframe-<wbr/>broker</span></a>
+<a href="modules/_openfin_core_web_shared_worker.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-2"></use></svg><span>@openfin/core-<wbr/>web/shared-<wbr/>worker</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Guides</h3><div class="tsd-index-list"><a href="documents/OpenFin_Web_Application_Developer_Guide.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8388608"></use></svg><span>Open<wbr/>Fin <wbr/>Web <wbr/>Application <wbr/>Developer <wbr/>Guide</span></a>
+<a href="documents/Platform_Developer_Guide.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8388608"></use></svg><span>Platform <wbr/>Developer <wbr/>Guide</span></a>
+</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="index.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/modules/_openfin_core_web.html ADDED Viewed

@@ -0,0 +1,19 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@openfin/core-web | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="_openfin_core_web.html">@openfin/core-web</a></li></ul><h1>Module @openfin/core-web</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The main entry point for leveraging OpenFin Web Interop in a web application.</p>
+</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Remarks" class="tsd-anchor"></a>Remarks<a href="#Remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This module provides a way to connect to an OpenFin Web Interop broker, which allows for communication between Web applications.</p>
+<h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">connect</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@openfin/core-web&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-6">fin</span><span class="hl-1"> = </span><span class="hl-4">await</span><span class="hl-1"> </span><span class="hl-0">connect</span><span class="hl-1">({</span><br/><span class="hl-1">   </span><span class="hl-5">options:</span><span class="hl-1"> {</span><br/><span class="hl-1">      </span><span class="hl-5">brokerUrl:</span><span class="hl-1"> </span><span class="hl-2">&#39;ws://localhost:9696/broker&#39;</span><br/><span class="hl-1">      </span><span class="hl-5">interopConfig</span><span class="hl-1">: {</span><br/><span class="hl-1">         </span><span class="hl-5">providerId:</span><span class="hl-1"> </span><span class="hl-2">&#39;my-provider-id&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">         </span><span class="hl-5">currentContextGroup:</span><span class="hl-1"> </span><span class="hl-2">&#39;my-context-group&#39;</span><br/><span class="hl-1">     }</span><br/><span class="hl-1">  }</span><br/><span class="hl-1"> });</span>
+</code><button type="button">Copy</button></pre>
+</div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/_openfin_core_web.BaseConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Base<wbr/>Config</span></a>
+<a href="../types/_openfin_core_web.BaseConnectionOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Base<wbr/>Connection<wbr/>Options</span></a>
+<a href="../types/_openfin_core_web.ConnectConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Connect<wbr/>Config</span></a>
+<a href="../types/_openfin_core_web.InheritModeConnectConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Inherit<wbr/>Mode<wbr/>Connect<wbr/>Config</span></a>
+<a href="../types/_openfin_core_web.StandAloneConnectConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Stand<wbr/>Alone<wbr/>Connect<wbr/>Config</span></a>
+<a href="../types/_openfin_core_web.ViewComponentConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>View<wbr/>Component<wbr/>Config</span></a>
+<a href="../types/_openfin_core_web.WebCreateLayoutOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Create<wbr/>Layout<wbr/>Options</span></a>
+<a href="../types/_openfin_core_web.WebLayoutComponent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Component</span></a>
+<a href="../types/_openfin_core_web.WebLayoutInitOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Init<wbr/>Options</span></a>
+<a href="../types/_openfin_core_web.WebLayoutOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Options</span></a>
+<a href="../types/_openfin_core_web.WebLayoutPlatformOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Platform<wbr/>Options</span></a>
+<a href="../types/_openfin_core_web.WebLayoutSnapshot.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Web<wbr/>Layout<wbr/>Snapshot</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_openfin_core_web.connect.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>connect</span></a>
+</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/modules/_openfin_core_web_iframe_broker.html ADDED Viewed

@@ -0,0 +1,10 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@openfin/core-web/iframe-broker | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="_openfin_core_web_iframe_broker.html">@openfin/core-web/iframe-broker</a></li></ul><h1>Module @openfin/core-web/iframe-broker</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This module is the entry point for the Iframe Broker. It is responsible for initializing the OpenFin Web Interop environment.</p>
+</div><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Remarks" class="tsd-anchor"></a>Remarks<a href="#Remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This module is intended to be used in an iframe context, and is responsible for setting up the connection between the iframe and the OpenFin Web Interop broker.
+This module requires hosting the script exported by the module:@openfin/core-web/worker module.</p>
+<h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-4">import</span><span class="hl-1"> { </span><span class="hl-5">init</span><span class="hl-1"> } </span><span class="hl-4">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@openfin/core-web/iframe-broker&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">init</span><span class="hl-1">({</span><br/><span class="hl-1">  </span><span class="hl-5">sharedWorkerUrl:</span><span class="hl-1"> </span><span class="hl-2">&#39;path to shared worker script&#39;</span><br/><span class="hl-1">});</span>
+</code><button type="button">Copy</button></pre>
+</div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/_openfin_core_web_iframe_broker.ConnectionOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Connection<wbr/>Options</span></a>
+</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_openfin_core_web_iframe_broker.init.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>init</span></a>
+<a href="../functions/_openfin_core_web_iframe_broker.rejectConnections.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>reject<wbr/>Connections</span></a>
+</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/modules/_openfin_core_web_shared_worker.html ADDED Viewed

@@ -0,0 +1,4 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@openfin/core-web/shared-worker | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="_openfin_core_web_shared_worker.html">@openfin/core-web/shared-worker</a></li></ul><h1>Module @openfin/core-web/shared-worker</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This file is the entry point for the worker powering web-interop.
+It has no exports and is intended to be hosted with the url given to the <code>sharedWorkerUrl</code> option in the Iframe Broker (see: <a href="_openfin_core_web_iframe_broker.html" class="tsd-kind-module">&quot;@openfin/core-web/iframe-broker&quot;</a>).</p>
+</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/_openfin_core_web_shared_worker.default.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>default</span></a>
+</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/out/docs/types/_openfin_core_web.BaseConfig.html ADDED Viewed

@@ -0,0 +1,3 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BaseConfig | @openfin/core-web</title><meta name="description" content="Documentation for @openfin/core-web"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfin/core-web</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@openfin/core-web</a></li><li><a href="../modules/_openfin_core_web.html">@openfin/core-web</a></li><li><a href="_openfin_core_web.BaseConfig.html">BaseConfig</a></li></ul><h1>Type Alias BaseConfig</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Base<wbr/>Config</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">platform</span><span class="tsd-signature-symbol">?: </span><a href="_openfin_core_web.WebLayoutPlatformOptions.html" class="tsd-signature-type tsd-kind-type-alias">WebLayoutPlatformOptions</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">platform</span><span class="tsd-signature-symbol">?: </span><a href="_openfin_core_web.WebLayoutPlatformOptions.html" class="tsd-signature-type tsd-kind-type-alias">WebLayoutPlatformOptions</a></h5><div class="tsd-comment tsd-typography"><p>Options used to initialize Web Layouts related features. If omitted, calling <code>fin.Platform.Layout.init()</code>
+will not work.</p>
+</div><div class="tsd-comment tsd-typography"></div></li></ul></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@openfin/core-web</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>