@openfin/fdc3-api 39.81.17 → 39.82.1

package/out/fdc3-api-alpha.d.ts

@@ -1599,11 +1599,8 @@ declare class Base {
     /* Excluded from this release type: __constructor */
     protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
     /**
-     * Provides access to the OpenFin representation of the current code context (usually a document
-     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
-     *
-     * Useful for debugging in the devtools console, where this will intelligently type itself based
-     * on the context in which the devtools panel was opened.
+     * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
+     * guaranteed to behave sensibly in all calling contexts.
      */
     get me(): Identity;
     /* Excluded from this release type: isNodeEnvironment */
@@ -3477,6 +3474,16 @@ declare type ConstWindowOptions = {
      * Default is white.
      */
     backgroundColor: string;
+    /**
+     * @defaultValue false
+     *
+     * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
+     * This also affects the Page Visibility API.
+     *
+     * When `true`, the page is throttled whether it is hidden or not.
+     *
+     */
+    backgroundThrottling: boolean;
     /**
      * Configures how new content (e,g, from `window.open` or a link) is opened.
      */
@@ -5542,6 +5549,13 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly Platform: PlatformModule;
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
+    /**
+     * Provides access to the OpenFin representation of the current code context (usually an entity
+     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
+     *
+     * Useful for debugging in the devtools console, where this will intelligently type itself based
+     * on the context in which the devtools panel was opened.
+     */
     readonly me: Me<MeType>;
 }
 
@@ -15590,7 +15604,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;

package/out/fdc3-api-beta.d.ts

@@ -1599,11 +1599,8 @@ declare class Base {
     /* Excluded from this release type: __constructor */
     protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
     /**
-     * Provides access to the OpenFin representation of the current code context (usually a document
-     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
-     *
-     * Useful for debugging in the devtools console, where this will intelligently type itself based
-     * on the context in which the devtools panel was opened.
+     * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
+     * guaranteed to behave sensibly in all calling contexts.
      */
     get me(): Identity;
     /* Excluded from this release type: isNodeEnvironment */
@@ -3477,6 +3474,16 @@ declare type ConstWindowOptions = {
      * Default is white.
      */
     backgroundColor: string;
+    /**
+     * @defaultValue false
+     *
+     * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
+     * This also affects the Page Visibility API.
+     *
+     * When `true`, the page is throttled whether it is hidden or not.
+     *
+     */
+    backgroundThrottling: boolean;
     /**
      * Configures how new content (e,g, from `window.open` or a link) is opened.
      */
@@ -5542,6 +5549,13 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly Platform: PlatformModule;
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
+    /**
+     * Provides access to the OpenFin representation of the current code context (usually an entity
+     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
+     *
+     * Useful for debugging in the devtools console, where this will intelligently type itself based
+     * on the context in which the devtools panel was opened.
+     */
     readonly me: Me<MeType>;
 }
 
@@ -15590,7 +15604,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;

package/out/fdc3-api-public.d.ts

@@ -1599,11 +1599,8 @@ declare class Base {
     /* Excluded from this release type: __constructor */
     protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
     /**
-     * Provides access to the OpenFin representation of the current code context (usually a document
-     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
-     *
-     * Useful for debugging in the devtools console, where this will intelligently type itself based
-     * on the context in which the devtools panel was opened.
+     * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
+     * guaranteed to behave sensibly in all calling contexts.
      */
     get me(): Identity;
     /* Excluded from this release type: isNodeEnvironment */
@@ -3477,6 +3474,16 @@ declare type ConstWindowOptions = {
      * Default is white.
      */
     backgroundColor: string;
+    /**
+     * @defaultValue false
+     *
+     * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
+     * This also affects the Page Visibility API.
+     *
+     * When `true`, the page is throttled whether it is hidden or not.
+     *
+     */
+    backgroundThrottling: boolean;
     /**
      * Configures how new content (e,g, from `window.open` or a link) is opened.
      */
@@ -5542,6 +5549,13 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly Platform: PlatformModule;
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
+    /**
+     * Provides access to the OpenFin representation of the current code context (usually an entity
+     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
+     *
+     * Useful for debugging in the devtools console, where this will intelligently type itself based
+     * on the context in which the devtools panel was opened.
+     */
     readonly me: Me<MeType>;
 }
 
@@ -15590,7 +15604,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;

package/out/fdc3-api.d.ts

@@ -1619,11 +1619,8 @@ declare class Base {
     constructor(wire: Transport);
     protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
     /**
-     * Provides access to the OpenFin representation of the current code context (usually a document
-     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
-     *
-     * Useful for debugging in the devtools console, where this will intelligently type itself based
-     * on the context in which the devtools panel was opened.
+     * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
+     * guaranteed to behave sensibly in all calling contexts.
      */
     get me(): Identity;
     /**
@@ -3536,6 +3533,16 @@ declare type ConstWindowOptions = {
      * Default is white.
      */
     backgroundColor: string;
+    /**
+     * @defaultValue false
+     *
+     * Determines whether WebContents will throttle animations and timers when the page becomes backgrounded.
+     * This also affects the Page Visibility API.
+     *
+     * When `true`, the page is throttled whether it is hidden or not.
+     *
+     */
+    backgroundThrottling: boolean;
     /**
      * Configures how new content (e,g, from `window.open` or a link) is opened.
      */
@@ -5627,6 +5634,13 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
     readonly Platform: PlatformModule;
     readonly Interop: InteropModule;
     readonly SnapshotSource: SnapshotSourceModule;
+    /**
+     * Provides access to the OpenFin representation of the current code context (usually an entity
+     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
+     *
+     * Useful for debugging in the devtools console, where this will intelligently type itself based
+     * on the context in which the devtools panel was opened.
+     */
     readonly me: Me<MeType>;
 }
 
@@ -16033,7 +16047,6 @@ declare interface ViewsPreventingUnloadPayload {
  * @interface
  */
 declare type ViewState = ViewCreationOptions & {
-    backgroundThrottling: boolean;
     componentName: 'view';
     initialUrl: string;
     minWidth?: number;

package/out/fdc3-api.js

@@ -486,11 +486,8 @@ class Base {
         return this.wire.getFin();
     }
     /**
-     * Provides access to the OpenFin representation of the current code context (usually a document
-     * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
-     *
-     * Useful for debugging in the devtools console, where this will intelligently type itself based
-     * on the context in which the devtools panel was opened.
+     * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
+     * guaranteed to behave sensibly in all calling contexts.
      */
     get me() {
         return this.wire.me;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "39.81.17",
+    "version": "39.82.1",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.MD",
     "private": false,