Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WorkspacePlatformStorage

API for interacting with persistent storage.

Hierarchy

  • WorkspacePlatformStorage

Index

Methods

createPage

  • 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});

    Parameters

    Returns Promise<void>

createWorkspace

  • Create a workspace in persistent storage.

    Parameters

    Returns Promise<void>

deletePage

  • deletePage(id: string): Promise<void>
  • Delete a page from persistent storage.

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

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

    Parameters

    • id: string

      the id of the page to delete.

    Returns Promise<void>

deleteWorkspace

  • deleteWorkspace(id: string): Promise<void>
  • Delete a workspace from persistent storage.

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

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

    Parameters

    • id: string

      the id of the workspace to delete.

    Returns Promise<void>

getPage

  • getPage(id: string): Promise<Page>
  • 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');

    Parameters

    • id: string

      the id of the page to get.

    Returns Promise<Page>

getPages

  • getPages(): Promise<Page[]>
  • 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();

    Returns Promise<Page[]>

getWorkspace

  • 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');

    Parameters

    • id: string

      the id of the workspace to get.

    Returns Promise<Workspace>

getWorkspaces

  • 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();

    Returns Promise<Workspace[]>

savePage

  • savePage(page: Page): Promise<void>
  • 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);

    Parameters

    • page: Page

      the page to save.

    Returns Promise<void>

saveWorkspace

  • saveWorkspace(workspace: Workspace): Promise<void>
  • 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.

    Parameters

    Returns Promise<void>

updatePage

  • 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);

    Parameters

    Returns Promise<void>

updateWorkspace

  • Update a workspace in persistent storage.

    Parameters

    Returns Promise<void>

Generated using TypeDoc