@openfin/workspace 6.2.2 → 6.3.0

package/client-api/src/shapes/store.d.ts

@@ -0,0 +1,467 @@
+/**
+ * Use relative paths here rather than aliases which mess
+ * up the packaged typing files. When writing code examples,
+ * for documentation, please use async/await syntax over .then()!
+ */
+/**
+ * Describes the type of the app directory entry `manifest` attributes.
+ * Launch mechanics are determined by the manifest type.
+ */
+export declare enum AppManifestType {
+    /**
+     * A snapshot manifest.
+     */
+    Snapshot = "snapshot",
+    /**
+     * A classic OpenFin app manifest.
+     */
+    Manifest = "manifest",
+    /**
+     * A view manifest.
+     */
+    View = "view",
+    /**
+     * A manifest for an external application.
+     */
+    External = "external"
+}
+export interface AppIntent {
+    name: string;
+    displayName: string;
+    contexts: string[];
+}
+/**
+ * Detailed metadata describing an image.
+ */
+export interface Image {
+    src: string;
+    type?: string;
+    size?: string;
+    purpose?: string;
+}
+/**
+ * Detailed metadata describing an application.
+ */
+export interface App {
+    /**
+     * Unique identifier for an application.
+     */
+    appId: string;
+    /**
+     * A UI friendly title for the application.
+     */
+    title: string;
+    /**
+     * URL to application manifest.
+     */
+    manifest: string;
+    /**
+     * UI friendly description for an application.
+     */
+    description?: string;
+    /**
+     * Describes the type of manifest resolved by the `manifest` field.
+     * Launch mechanics are determined by the manifest type.
+     */
+    manifestType: AppManifestType | string;
+    /**
+     * A list of icons that can be rendered in UI for this application.
+     */
+    icons: Image[];
+    /**
+     * A list of optional images that highlight application functionality.
+     */
+    images?: Image[];
+    intents?: AppIntent[];
+    tags?: string[];
+    version?: string;
+    publisher: string;
+    contactEmail?: string;
+    supportEmail?: string;
+}
+export declare enum StorefrontTemplate {
+    LandingPage = "landingPage",
+    AppGrid = "appGrid"
+}
+/**
+ * Represents a link to be rendered inside Storefront.
+ */
+export interface StorefrontLink {
+    /**
+     * A UI friendly title to render the link as.
+     */
+    title: string;
+    /**
+     * When the rendered `title` text is clicked, the user will be navigated to this URL.
+     */
+    url: string;
+}
+export interface StorefrontFooter {
+    /**
+     * A logo to be displayed on the Storefront's footer.
+     */
+    logo: Image;
+    /**
+     * A set of links to display on Storefront's footer.
+     */
+    links: [StorefrontLink?, StorefrontLink?, StorefrontLink?];
+    text: string;
+}
+/**
+ * Render a navigation section on the left panel of Storefront.
+ */
+export interface StorefrontNavigationSection {
+    /**
+     * Unique identifier for the navigation section.
+     */
+    id: string;
+    /**
+     * The UI friendly title of the navigation section.
+     */
+    title: string;
+    /**
+     * Navigation items to render under this section.
+     * 1-5 Navigation Items are supported.
+     */
+    items: [
+        StorefrontNavigationItem,
+        StorefrontNavigationItem?,
+        StorefrontNavigationItem?,
+        StorefrontNavigationItem?,
+        StorefrontNavigationItem?
+    ];
+}
+export interface StorefrontLandingPage {
+    hero?: {
+        title: string;
+        description: string;
+        cta: StorefrontNavigationItem;
+        image: Image;
+    };
+    topRow: {
+        title: string;
+        items: [
+            StorefrontDetailedNavigationItem?,
+            StorefrontDetailedNavigationItem?,
+            StorefrontDetailedNavigationItem?,
+            StorefrontDetailedNavigationItem?
+        ];
+    };
+    middleRow: {
+        title: string;
+        apps: [App?, App?, App?, App?, App?, App?];
+    };
+    bottomRow: {
+        title: string;
+        items: [
+            StorefrontDetailedNavigationItem?,
+            StorefrontDetailedNavigationItem?,
+            StorefrontDetailedNavigationItem?
+        ];
+    };
+}
+/**
+ * Render a grid of applications in Storefront.
+ */
+export interface StorefrontAppGrid {
+    /**
+     * The apps to render in the grid.
+     */
+    apps: App[];
+}
+export interface StorefrontNavigationItemBase {
+    /**
+     * An ID for referencing the navigation item. Must be unique.
+     */
+    id: string;
+    /**
+     * UI friendly name for the navigation item.
+     */
+    title: string;
+}
+export interface StorefrontNavigationItemDetails {
+    description: string;
+    image: Image;
+}
+/**
+ * Template for rendering a navigation item that renders a app grid when clicked.
+ */
+export interface StorefrontNavigationItemAppGrid extends StorefrontNavigationItemBase {
+    templateId: StorefrontTemplate.AppGrid;
+    /**
+     * Render an app grid when navigation item is pressed.
+     */
+    templateData: StorefrontAppGrid;
+}
+/**
+ * Template for rendering a navigation item that renders another landing page when clicked.
+ */
+export interface StorefrontNavigationItemLandingPage extends StorefrontNavigationItemBase {
+    templateId: StorefrontTemplate.LandingPage;
+    /**
+     * Render a landing page when navigation item is pressed.
+     */
+    templateData: StorefrontLandingPage;
+}
+/**
+ * Render an item in the navigation bar of Storefront.
+ */
+export declare type StorefrontNavigationItem = StorefrontNavigationItemAppGrid | StorefrontNavigationItemLandingPage;
+/**
+ *  Render an item in the navigation bar of Storefront with a description and image.
+ */
+export declare type StorefrontDetailedNavigationItem = StorefrontNavigationItem & StorefrontNavigationItemDetails;
+export interface StorefrontProviderInfo {
+    /**
+     * Unique identifier for the Storefront provider.
+     */
+    id: string;
+    /**
+     * A UI friendly title for the platform Storefront.
+     * This will be used in the Storefront selection dropdown.
+     */
+    title: string;
+    /**
+     * Icon for storefront provider.
+     * Visible next to title in storefront provider selector UI
+     */
+    icon: string;
+}
+/**
+ * Describes a Storefront provided by a platform.
+ * A platform must provide an object that satisfies this interface in order to register with the Storefront.
+ */
+export interface StorefrontProvider extends StorefrontProviderInfo {
+    /**
+     * Get a list of apps to populate the platform's Storefront with.
+     *
+     * ```ts
+     *
+     * const app : App = {
+     *      appId: 'uid'
+     *      title: 'My App'
+     *      manifest: `https://openfin-iex.experolabs.com/openfin/manifests/cash-flow.json`,
+     *      icons: [
+     *          {
+     *              src: '/icon.png'
+     *          }
+     *      ],
+     *      contactEmail: contact@email.com,
+     *      supportEmail: support@email.com,
+     *      publisher: 'My Publisher',
+     *      tags: [],
+     *      images: [],
+     *      intents: []
+     * }
+     *
+     * const getApps = async (): Promise<App[]> => {
+     *      return [app];
+     * }
+     * ```
+     */
+    getApps(): Promise<App[]>;
+    /**
+     * Get the main landing page for the platform's Storefront.
+     *
+     * ```ts
+     *
+     * const landingPage : StorefrontLandingPage = {
+     *   hero: {
+     *      title: 'My Landing Page',
+     *      description: 'description',
+     *      cta: navigationItems[0],
+     *      image: {
+     *          src: './images/image.png'
+     *      }
+     *   },
+     *   topRow: {
+     *       title: 'Top Row Title',
+     *       items: //array of StorefrontNavigationItem
+     *   },
+     *   middleRow: {
+     *       title: 'Middle Row Title',
+     *       apps: //array of apps
+     *   },
+     *   bottomRow: {
+     *       title: 'Bottom Row Title',
+     *       items: //array of StorefrontNavigationItem
+     *   }
+     * }
+     *
+     * const getLandingPage = async (): Promise<StorefrontLandingPage> => {
+     *      return landingPage;
+     * }
+     *```
+     */
+    getLandingPage(): Promise<StorefrontLandingPage>;
+    /**
+     * Get the Storefront navigation sections for the left nav bar.
+     * ```ts
+     * const navigationSections: [StorefrontNavigationSection, StorefrontNavigationSection] = [
+     *   {
+     *       id: 'first id',
+     *       title: 'title',
+     *       items: //array of navigation items
+     *   },
+     *   {
+     *       id: 'second id'
+     *       title: 'title',
+     *       items: //array of navigation items
+     *   }
+     * ]
+     *
+     * const getNavigation = async (): Promise<[StorefrontNavigationSection, StorefrontNavigationSection]>  => {
+     *      return navigationSections;
+     * }
+     *```
+     */
+    getNavigation(): Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
+    /**
+     * Get the footer for the platform's Storefront.
+     *
+     * ```ts
+     * const footer: StorefrontFooter = {
+     *      logo: { src: './images/image', size: '32' },
+     *      text: 'footer text',
+     *      links: [
+     *          { title:'title', url: 'https://openfin.co' },
+     *          { title: 'title', url: 'https://openfin.co'}
+     *      ]
+     * }
+     *
+     * const getFooter = async (): Promise<StorefrontFooter> => {
+     *      return footer;
+     * }
+     * ```
+     */
+    getFooter(): Promise<StorefrontFooter>;
+    /**
+     * Launch an app provided by the platform's Storefront.
+     *
+     * ```ts
+     * import { getStorefrontProvider } from "./my-provider";
+     *
+     * //Grab your provider
+     * const myStoreFrontProvider: StorefrontProvider = getStorefrontProvider();
+     *
+     * const app : App = {
+     *      appId: 'uid'
+     *      title: 'My App'
+     *      manifest: `https://openfin-iex.experolabs.com/openfin/manifests/cash-flow.json`,
+     *      icons: [
+     *          {
+     *              src: './image.png'
+     *          }
+     *      ],
+     *      contactEmail: contact@email.com,
+     *      supportEmail: support@email.com,
+     *      publisher: 'My Publisher',
+     *      tags: [],
+     *      images: [],
+     *      intents: []
+     * }
+     *
+     * const launch = async () => {
+     *      await myStorefrontProvider.launchApp(app);
+     * }
+     * ```
+     * @param app the app to launch.
+     */
+    launchApp(app: App): Promise<void>;
+}
+/**
+ * Interface that contains functions for integrating with Storefront.
+ */
+export interface StorefrontAPI {
+    /**
+   * Registers a [[`StorefrontProvider`]]. Upon registering a provider,
+   * the title of your provider appears in the menu of the Storefront UI.
+   * When a user selects your Storefront, the methods on the provider
+   * object are called to populate the UI. Throws an error if a provider with
+   * the same `id` already exists.
+   *
+   * ```ts
+   * import { Storefront, StorefrontProvider } from "@openfin/workspace";
+   *
+   * //Declare a provider
+   * const myStorefrontProvider: StorefrontProvider = {
+   *      id: "my-storefront-id"
+   *      title: "My StorefrontProvider"
+   *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
+   *      getApps: () => {...},
+   *      getNavigation: () => {...},
+   *      getLandingPage: () => {...},
+   *      getFooter: () => {...},
+   *      launchApp: () => {...}
+   * };
+   *
+   * const registerProvider = async () => {
+   *      await Storefront.register(myStorefrontProvider);
+   * }
+   * ```
+   * @param provider the implementation of a Storefront provider.
+
+   */
+    register(provider: StorefrontProvider): Promise<void>;
+    /**
+     * Deregister a provider.
+     *
+     * ```ts
+     * import { Storefront, StorefrontProvider } from "@openfin/workspace";
+     *
+     * //Instantiate a StorefrontProvider
+     * const myStorefrontProvider: StorefrontProvider = {
+     *      id: "my-storefront-id"
+     *      title: "My StoreFrontProvider"
+     *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
+     *      getApps: () => {...},
+     *      getNavigation: () => {...},
+     *      getLandingPage: () => {...},
+     *      getFooter: () => {...},
+     *      launchApp: () => {...}
+     * };
+     *
+     * const register = async () => {
+     *      await Storefront.register(myStorefrontProvider);
+     * }
+     *
+     * //Do work with myStorefrontProvider
+     *
+     * const deregister = async () => {
+     *      await Storefront.deregister("my-storefront-id");
+     * }
+     * ```
+     * @param id the id of the provider.
+     */
+    deregister(id: string): Promise<void>;
+    /**
+     * Shows the Storefront window. Awaits for the latest [[`Storefront.register()`]]
+     * internally, so you don't have to. Throws an error if a [[StorefrontProvider]]
+     * doesn't exist (i.e., because `register()` not called previously).
+     *
+     * ```ts
+     * import { Storefront } from "@openfin/workspace";
+     *
+     * const show = async () => {
+     *      await Storefront.show();
+     *      //Do thing after show
+     * }
+     * ```
+     */
+    show(): Promise<void>;
+    /**
+     * Hides the Storefront window. Awaits for the latest [[`Storefront.register()`]]
+     * internally, so you don't have to. Throws an error if a [[StorefrontProvider]]
+     * doesn't exist (i.e., because `register()` was not called previously).
+     *
+     * ```ts
+     * import { Storefront } from "@openfin/workspace";
+     *
+     * const hide = async () => {
+     *      await Storefront.hidef();
+     *      //Do thing after show
+     * }
+     * ```
+     */
+    hide(): Promise<void>;
+}

package/client-api/src/storefront.d.ts

@@ -1,4 +1,5 @@
-import type { StorefrontProvider } from './shapes';
+import type { StorefrontProvider } from './shapes/store';
+export * from './shapes/store';
 /**
  * Registers a Storefront provider
  */

package/client-api-platform/src/api/app-directory.d.ts

@@ -0,0 +1,7 @@
+import type { LaunchAppRequest } from '../shapes';
+/**
+ * Launch the app described by an App Directory entry.
+ * @param app the app directory entry.
+ * @param opts launch options.
+ */
+export declare function launchApp({ app, target }: LaunchAppRequest): Promise<void | import("openfin-adapter").Application | import("openfin-adapter").View | import("openfin-adapter/src/api/platform").Platform | import("openfin-adapter").Identity>;

package/client-api-platform/src/api/browser/browser-module.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="openfin-adapter/fin" />
+import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../../../common/src/api/pages/shapes';
+import { OpenPageTabContextMenuRequest } from '../../../../client-api-platform/src/index';
+import { OpenGlobalContextMenuRequest, OpenViewTabContextMenuRequest, ToolbarOptions, WindowStateButtonOptions } from '../../../../client-api-platform/src/shapes';
+export declare const getBrowserModule: (identity: OpenFin.Identity) => {
+    identity: OpenFin.Identity;
+    openfinWindow: import("openfin-adapter").Window;
+    getPages: () => Promise<AttachedPage[]>;
+    getPage: (pageId: string) => Promise<AttachedPage>;
+    addPage: (page: PageWithUpdatableRuntimeAttribs) => Promise<void>;
+    removePage: (id: Page['pageId']) => Promise<void>;
+    setActivePage: (id: Page['pageId']) => Promise<void>;
+    updatePage: (req: any) => Promise<any>;
+    reorderPages: (req: any) => Promise<any>;
+    _openGlobalContextMenu: (req: OpenGlobalContextMenuRequest) => Promise<any>;
+    replaceToolbarOptions: (options: ToolbarOptions) => Promise<void>;
+    replaceWindowStateButtonOptions: (options: WindowStateButtonOptions) => Promise<void>;
+    _openViewTabContextMenu: (req: OpenViewTabContextMenuRequest) => Promise<any>;
+    _openPageTabContextMenu: (req: OpenPageTabContextMenuRequest) => Promise<any>;
+};

package/client-api-platform/src/api/browser/index.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="openfin-adapter/fin" />
+import type { AttachedPage } from '../../../../common/src/api/pages/shapes';
+import type { BrowserCreateWindowRequest, BrowserWindowModule } from '../../shapes';
+export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
+    wrapSync: (windowIdentity: OpenFin.Identity) => {
+        identity: OpenFin.Identity;
+        openfinWindow: import("openfin-adapter").Window;
+        getPages: () => Promise<AttachedPage[]>;
+        getPage: (pageId: string) => Promise<AttachedPage>;
+        addPage: (page: import("@common/api/pages/shapes").PageWithUpdatableRuntimeAttribs) => Promise<void>;
+        removePage: (id: string) => Promise<void>;
+        setActivePage: (id: string) => Promise<void>;
+        updatePage: (req: any) => Promise<any>;
+        reorderPages: (req: any) => Promise<any>;
+        _openGlobalContextMenu: (req: import("../../shapes").OpenGlobalContextMenuRequest) => Promise<any>;
+        replaceToolbarOptions: (options: import("../../shapes").ToolbarOptions) => Promise<void>;
+        replaceWindowStateButtonOptions: (options: import("../../shapes").WindowStateButtonOptions) => Promise<void>;
+        _openViewTabContextMenu: (req: import("../../shapes").OpenViewTabContextMenuRequest) => Promise<any>;
+        _openPageTabContextMenu: (req: import("../../shapes").OpenPageTabContextMenuRequest) => Promise<any>;
+    };
+    createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;
+    getAllAttachedPages: () => Promise<AttachedPage[]>;
+    getAllWindows: () => Promise<BrowserWindowModule[]>;
+    getUniquePageTitle: (title?: string) => Promise<any>;
+    getLastFocusedWindow: () => Promise<any>;
+};

package/client-api-platform/src/api/context-menu/browser-logo-handler.d.ts

@@ -0,0 +1,3 @@
+import { GlobalContextMenuItemData, OpenGlobalContextMenuPayload } from '../../shapes';
+declare const handler: (data: GlobalContextMenuItemData, payload: OpenGlobalContextMenuPayload) => Promise<void>;
+export default handler;

package/client-api-platform/src/api/context-menu/browser-pagetab-handler.d.ts

@@ -0,0 +1,3 @@
+import { OpenPageTabContextMenuPayload } from '../../../../client-api-platform/src/index';
+import { PageTabContextMenuItemData } from '../../../../client-api-platform/src/shapes';
+export declare const pageTabContextMenuItemHandler: (data: PageTabContextMenuItemData, payload: OpenPageTabContextMenuPayload) => Promise<void>;

package/client-api-platform/src/api/context-menu/browser-viewtab-handler.d.ts

@@ -0,0 +1,3 @@
+import { OpenViewTabContextMenuPayload, ViewTabMenuData } from '../../../../client-api-platform/src/index';
+declare const handler: (data: ViewTabMenuData, payload: OpenViewTabContextMenuPayload) => Promise<void>;
+export default handler;

package/client-api-platform/src/api/context-menu/index.d.ts

@@ -0,0 +1,13 @@
+import { NamedIdentity } from 'openfin-adapter/src/identity';
+import { OpenPageTabContextMenuPayload } from '../../../../client-api-platform/src/index';
+import { OpenGlobalContextMenuPayload, OpenGlobalContextMenuRequest, OpenPageTabContextMenuRequest, OpenViewTabContextMenuPayload, OpenViewTabContextMenuRequest } from '../../../../client-api-platform/src/shapes';
+export declare function openGlobalContextMenuInternal(payload: OpenGlobalContextMenuRequest & {
+    identity: NamedIdentity;
+}, callerIdentity: any): Promise<void>;
+export declare const openCommonContextMenu: (payload: OpenGlobalContextMenuPayload | OpenViewTabContextMenuPayload | OpenPageTabContextMenuPayload, callerIdentity: any) => Promise<void>;
+export declare function openViewTabContextMenuInternal(payload: OpenViewTabContextMenuRequest & {
+    identity: NamedIdentity;
+}, callerIdentity: any): Promise<void>;
+export declare function openPageTabContextMenuInternal(payload: OpenPageTabContextMenuRequest & {
+    identity: NamedIdentity;
+}, callerIdentity: any): Promise<void>;

package/client-api-platform/src/api/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="openfin-adapter/fin" />
+import { WorkspacePlatformModule } from '../shapes';
+export declare const wrapSync: (identity: OpenFin.ApplicationIdentity) => WorkspacePlatformModule;
+export declare const getCurrentSync: () => WorkspacePlatformModule;

package/client-api-platform/src/api/pages/helper.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="openfin-adapter/fin" />
+import { SnapshotExtended } from '../../../../common/src/utils/snapshot';
+/**
+ * Get a snapshot with pages.
+ *
+ * Makes sure that the layout of the page is up to date with the window's layout.
+ *
+ * @returns a snapshot with windows that contain pages.
+ */
+export declare function getSnapshotWithPages(superGetSnapshot?: () => Promise<SnapshotExtended>): Promise<SnapshotExtended>;
+/**
+ * Launch a snapshot that contains windows with pages.
+ *
+ * If a page with the same ID is already launched in the platform,
+ * focus and set it as the active page.
+ *
+ * If there is no page on the desktop with the same ID, launch
+ * the new window with the page.
+ *
+ * @param snapshot the snapshot to launch.
+ */
+export declare function applySnapshotWithPages(snapshot: OpenFin.Snapshot, superApplySnapshot?: (superSnapshot: OpenFin.Snapshot) => Promise<void>): Promise<void>;

package/client-api-platform/src/api/pages/index.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="openfin-adapter/fin" />
+import type { AttachPagesToWindowPayload } from '../../../../common/src/api/pages/shapes';
+import type { CreateSavedPageRequest, Page, UpdateSavedPageRequest } from '../../../../client-api-platform/src/shapes';
+/**
+ * Get all open pages in which are attached to a window.
+ * @returns the list of attached pages.
+ */
+export declare const getAllAttachedPages: () => Promise<import("@client-platform/shapes").AttachedPage[]>;
+export declare const createSavedPageInternal: ({ page }: CreateSavedPageRequest) => Promise<void>;
+export declare const deleteSavedPageInternal: (id: string) => Promise<void>;
+export declare const updateSavedPageInternal: ({ pageId, page }: UpdateSavedPageRequest) => Promise<any>;
+export declare const savePage: (page: Page) => Promise<any>;
+export declare const attachPagesToWindow: (payload: AttachPagesToWindowPayload) => Promise<void>;
+export declare const updatePageForWindow: (payload: any) => Promise<void>;
+export declare const detachPagesFromWindow: (payload: any) => Promise<void>;
+export declare const setActivePage: (payload: any) => Promise<void>;
+export declare const getPagesForWindow: (identity: OpenFin.Identity) => Promise<import("@client-platform/shapes").AttachedPage[]>;
+export declare const getPageForWindow: ({ identity, pageId }: {
+    identity: any;
+    pageId: any;
+}) => Promise<import("@client-platform/shapes").AttachedPage>;
+export declare const reorderPagesForWindow: (payload: any) => Promise<void>;
+export declare const getActivePageIdForWindow: (identity: any) => Promise<string>;
+/**
+ * Checks if a given page name is unique
+ * If not, add a progressive number to it
+ * @param initialName The initial name to test
+ * @returns string: a unique page name
+ */
+export declare function getUniquePageTitle(initialName?: string): Promise<string>;

package/client-api-platform/src/api/protocol.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="openfin-adapter/fin" />
+/**
+ * All of the remote procedures that can be called in the
+ * a Workspace Platform's address space.
+ *
+ * When adding a new channel action make sure to add a function that's name matches
+ * the value of the enum for the remote procedure in the Workspace Platform overrides and the override-callback.
+ * All of the registered channel action handlers can be found here in the platform's overrides:
+ * @see link: [Provider Protocol Handlers](https://github.com/openfin/workspace/client-api-platform/src/init/override-callback.ts)
+ */
+export declare enum ChannelAction {
+    LaunchApp = "launchApp",
+    SavePage = "savePage",
+    GetSavedPage = "getSavedPage",
+    CreateSavedPage = "createSavedPage",
+    UpdateSavedPage = "updateSavedPage",
+    DeleteSavedPage = "deleteSavedPage",
+    GetSavedPages = "getSavedPages",
+    CreateSavedPageInternal = "createSavedPageInternal",
+    UpdateSavedPageInternal = "updateSavedPageInternal",
+    DeleteSavedPageInternal = "deleteSavedPageInternal",
+    SharePage = "sharePage",
+    UpdatePageForWindow = "updatePageForWindow",
+    AttachPagesToWindow = "attachPagesToWindow",
+    DetachPagesFromWindow = "detachPagesFromWindow",
+    ReorderPagesForWindow = "reorderPagesForWindow",
+    SetActivePage = "setActivePage",
+    GetAllAttachedPages = "getAllAttachedPages",
+    GetActivePageIdForWindow = "getActivePageIdForWindow",
+    GetPagesForWindow = "getPagesForWindow",
+    GetPageForWindow = "getPageForWindow",
+    GetSavedPageMetadata = "getSavedPageMetadata",
+    GetUniquePageTitle = "getUniquePageTitle",
+    GetLastFocusedBrowserWindow = "getLastFocusedBrowserWindow",
+    GetThemes = "getThemes",
+    OpenGlobalContextMenuInternal = "openGlobalContextMenuInternal",
+    OpenViewTabContextMenuInternal = "openViewTabContextMenuInternal",
+    OpenPageTabContextMenuInternal = "openPageTabContextMenuInternal",
+    InvokeCustomActionInternal = "invokeCustomActionInternal"
+}
+/**
+ * Get a channel client for a specific Workspace platform.
+ *
+ * The channel client can execute remote procedures on the platform via its `dispatch` function.
+ * A call to the `dispatch` function will block until the channel action has concluded execution
+ * in the Workspace platform's address space.
+ * For a list of supported procedures, see the `ChannelAction` enum.
+ *
+ * @returns the channel client for the Workspace platform.
+ */
+export declare const getChannelClient: (identity: OpenFin.ApplicationIdentity) => Promise<import("openfin-adapter").ChannelClient>;