@openfin/workspace-platform 4.16.0 → 4.17.0

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

@@ -82,6 +82,7 @@ export interface BrowserWindowModule {
      * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists
      * const windows = await workspacePlatform.Browser.getAllWindows();
      * const page = await windows[0].getPage('MyPageId');
      * ```
@@ -95,6 +96,7 @@ export interface BrowserWindowModule {
      * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists
      * const windows = await workspacePlatform.Browser.getAllWindows();
      * const pages = await windows[0].getPages();
      * ```
@@ -107,6 +109,7 @@ export interface BrowserWindowModule {
      * import * as WorkspacePlatform from '@openfin/workspace-platform';
      *
      * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists
      * const windows = await workspacePlatform.Browser.getAllWindows();
      * await windows[0].setActivePage('MyPageId');
      * ```
@@ -143,6 +146,7 @@ export interface BrowserWindowModule {
      *      pageId: 'myPageId',
      *      layout
      * };
+     * // assume a browser window already exists
      * const windows = await workspacePlatform.Browser.getAllWindows();
      * await windows[0].addPage(page);
      * ```
@@ -151,16 +155,69 @@ export interface BrowserWindowModule {
     addPage(page: PageWithUpdatableRuntimeAttribs): Promise<void>;
     /**
      * Remove an attached page from the browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * await windows[0].removePage('myPageId');
+     * ```
      * @param id the id of the attached page to remove from the browser window.
      */
     removePage(id: string): Promise<void>;
     /**
      * Update a page in which is attached to the browser window.
+     *
+     * ```ts
+     * 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
+     * };
+     * // assume a browser window already exists
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * const req = {
+     *      pageId: 'myPageId',
+     *      page
+     * };
+     * await windows[0].updatePage(req);
+     * ```
      * @param req the update request.
      */
     updatePage(req: UpdateAttachedPageRequest): Promise<void>;
     /**
      * Reorder pages attached to the browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * // assume a browser window already exists and has three pages in it
+     * const windows = await workspacePlatform.Browser.getAllWindows();
+     * await windows[0].reorderPages(['myPageId2', 'myPageId1', 'myPageId3']);
+     * ```
      * @param req the reorder pages request.
      */
     reorderPages(req: ReorderPagesRequest): Promise<void>;
@@ -241,11 +298,25 @@ export interface BrowserWindowFactory {
     createWindow(options: BrowserCreateWindowRequest): Promise<BrowserWindowModule>;
     /**
      * Get a unique title for a page.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const uniqueTitle = await workspacePlatform.Browser.getUniquePageTitle('myTitle');
+     * ```
      * @param title a prefix for the title.
      */
     getUniquePageTitle(title?: string): Promise<string>;
     /**
      * Get the identity of the last focused Browser window.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const windowIdentity = await workspacePlatform.Browser.getLastFocusedWindow();
+     * ```
      */
     getLastFocusedWindow(): Promise<OpenFin.Identity>;
 }

package/package.json

@@ -1 +1 @@
-{"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"4.16.0","main":"index.ts","scripts":{"deploy":"npm run deploy:npm && npm run deploy:docs","deploy:npm":"cd out && npm publish","deploy:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/","deploy:next":"npm run deploy:next:npm && npm run deploy:next:docs","deploy:next:npm":"cd out && npm publish --tag next","deploy:next:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/next/","cp:readme":"copyfiles README.md out","cp:package":"node ../common/scripts/cp-package.js","cp:next:package":"node ../common/scripts/cp-package-next.js","create:rootIndex":"node ../common/scripts/cp-root-index.js","package":"npm run cp:readme && npm run cp:package && npm run create:rootIndex","package:next":"npm run cp:readme && npm run cp:next:package && npm run create:rootIndex","clean":"rimraf ./out && rimraf ./docs","build:common":"cross-env ENV=prod webpack --mode=production --config ./webpack.common.config.js","build":"npm run clean && npm run build:common && npm run build:docs","build:docs":"typedoc --tsconfig ./tsconfig.json --readme none --disableSources ./src/index.ts","test":"jest --watch --colors","test:ci":"jest"},"keywords":["client","api","workspace","platform"],"license":"MIT"}
+{"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"4.17.0","main":"index.ts","scripts":{"deploy":"npm run deploy:npm && npm run deploy:docs","deploy:npm":"cd out && npm publish","deploy:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/","deploy:next":"npm run deploy:next:npm && npm run deploy:next:docs","deploy:next:npm":"cd out && npm publish --tag next","deploy:next:docs":"aws s3 cp --recursive ./docs/ s3://cdn.openfin.co/workspace/api/platform/docs/next/","cp:readme":"copyfiles README.md out","cp:package":"node ../common/scripts/cp-package.js","cp:next:package":"node ../common/scripts/cp-package-next.js","create:rootIndex":"node ../common/scripts/cp-root-index.js","package":"npm run cp:readme && npm run cp:package && npm run create:rootIndex","package:next":"npm run cp:readme && npm run cp:next:package && npm run create:rootIndex","clean":"rimraf ./out && rimraf ./docs","build:common":"cross-env ENV=prod webpack --mode=production --config ./webpack.common.config.js","build":"npm run clean && npm run build:common && npm run build:docs","build:docs":"typedoc --tsconfig ./tsconfig.json --readme none --disableSources ./src/index.ts","test":"jest --watch --colors","test:ci":"jest"},"keywords":["client","api","workspace","platform"],"license":"MIT"}