Interface WorkspacePlatformStorage

Create a page in persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
const layout = {
     content: [
         {
             type: 'stack',
             content: [
                 {
                     type: 'component',
                     componentName: 'view',
                     componentState: {
                         name: 'myViewName',
                         url: 'http://google.com'
                     }
                 }
             ]
          }
     ]
};
const page = {
     title: 'myPageTitle',
     pageId: 'myPageId',
     layout
};
await workspacePlatform.Storage.createPage({page});
Copy

Create a workspace in persistent storage.

Delete a page from persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
await workspacePlatform.Storage.deletePage('myPageId');
Copy

Delete a workspace from persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
await workspacePlatform.Storage.deleteWorkspace('myWorkspaceId');
Copy

Implementation for getting the dock provider from persistent storage.

Get a specific page in persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
const myPage = await workspacePlatform.Storage.getPage('myPageId');
Copy

Get all pages that are saved in persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
const pages = await workspacePlatform.Storage.getPages();
Copy

Get a specific workspace in persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
const myWorkspace = await workspacePlatform.Storage.getWorkspace('myWorkspaceId');
Copy

Get all workspaces that are saved in persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
const workspaces = await workspacePlatform.Storage.getWorkspaces();
Copy

Get all workspaces metadata including the workspaceId and title that are saved in persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
const workspacesMetadata = await workspacePlatform.Storage.getWorkspacesMetadata();
Copy

Implementation for saving a dock provider config to persistent storage.

Save a page in persistent storage.

This is a helper function that will call getPage to determine if a page is already in storage. If the page is already in storage, it will call updatePage. If it does not exist in storage, the function will call createPage instead.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
const layout = {
     content: [
         {
             type: 'stack',
             content: [
                 {
                     type: 'component',
                     componentName: 'view',
                     componentState: {
                         name: 'myViewName',
                         url: 'http://google.com'
                     }
                 }
             ]
          }
     ]
};
const page = {
     title: 'myPageTitle',
     pageId: 'myPageId',
     layout
};
await workspacePlatform.Storage.savePage(page);
Copy

Save a workspace in persistent storage.

This is a helper function that will call getWorkspace to determine if a workspace is already in storage. If the workspace is already in storage, it will call updateWorkspace. If it does not exist in storage, the function will call createWorkspace instead.

Update a page in persistent storage.

import * as WorkspacePlatform from '@openfin/workspace-platform';

const workspacePlatform = WorkspacePlatform.getCurrentSync();
const layout = {
     content: [
         {
             type: 'stack',
             content: [
                 {
                     type: 'component',
                     componentName: 'view',
                     componentState: {
                         name: 'myViewName',
                         url: 'http://google.com'
                     }
                 }
             ]
          }
     ]
};
const page = {
     title: 'myPageTitle',
     pageId: 'myPageId',
     layout
};
const req = {
     pageId: 'myPageId',
     page
};
await workspacePlatform.Storage.updatePage(req);
Copy

Update a workspace in persistent storage.