@openfin/workspace-platform 4.19.0 → 4.20.0

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.
@@ -506,6 +506,28 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
506
506
  getSnapshot(): Promise<BrowserSnapshot>;
507
507
  /**
508
508
  * Launch an application.
509
+ * ```ts
510
+ * import * as WorkspacePlatform from '@openfin/workspace-platform';
511
+ *
512
+ * const workspacePlatform = WorkspacePlatform.getCurrentSync();
513
+ * const req = {
514
+ * app: {
515
+ * appId: 'myAppId',
516
+ * title: 'appTitle',
517
+ * manifest: 'http://localhost/app.json',
518
+ * manifestType: AppManifestType.Manifest,
519
+ * icons:[
520
+ * {
521
+ * icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
522
+ * src: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
523
+ * type: "ico",
524
+ * },
525
+ * ]
526
+ * }
527
+ * }
528
+ * workspacePlatform.launchApp(req);
529
+ *
530
+ * ```
509
531
  * @param req the launch app request.
510
532
  */
511
533
  launchApp(req: LaunchAppRequest): Promise<void>;
@@ -517,6 +539,9 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
517
539
  * The storage API for the Workspace Platform.
518
540
  */
519
541
  Storage: WorkspacePlatformStorage;
542
+ /**
543
+ * Theme API for the Workspace Platform.
544
+ */
520
545
  Theme: ThemeApi;
521
546
  }
522
547
  export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
package/package.json CHANGED
@@ -1 +1 @@
1
- {"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"4.19.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"}
1
+ {"name":"@openfin/workspace-platform","description":"An API for creating your own Workspace platform.","contributors":[],"version":"4.20.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"}