@openfin/fdc3-api 41.100.27 → 41.100.29

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

@@ -5932,11 +5932,8 @@ declare type FrameEventType = EventType_5;
 /**
  * @interface
  */
-declare type FrameInfo = {
-    name: string;
-    uuid: string;
+declare type FrameInfo = EntityInfo & {
     url: string;
-    entityType: EntityType_4;
     parent: Identity_4;
 };
 
@@ -9632,6 +9629,8 @@ declare namespace OpenFin {
         ClientConnectionPayload,
         EntityInfo,
         EntityType_4 as EntityType,
+        ScreenCaptureState,
+        ScreenCapturePermission,
         Bounds,
         WindowBounds,
         Rectangle,
@@ -9851,6 +9850,7 @@ declare namespace OpenFin {
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
+        ScreenCaptureBehavior,
         PerDomainSettings,
         DomainSettingsRule,
         FileDownloadBehavior,
@@ -10164,6 +10164,12 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    contentProtection?: {
+        /**
+         * {@inheritdoc ScreenCaptureBehavior}
+         */
+        screenCapture: ScreenCaptureBehavior;
+    };
 };
 
 /**
@@ -12809,6 +12815,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.PopupResult;
     };
+    'get-screen-capture-permissions': {
+        request: OpenFin.Identity;
+        response: OpenFin.ScreenCapturePermission;
+    };
     'render-overlay': {
         request: {
             bounds: OpenFin.Bounds;
@@ -13338,6 +13348,31 @@ declare type RvmLaunchOptions = {
     subscribe?: (launch: LaunchEmitter) => void;
 };
 
+/**
+ * @interface
+ * Controls whether this content should be allowed or blocked when capturing the screen.
+ */
+declare type ScreenCaptureBehavior = 'allow' | 'block';
+
+/**
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
+ * @interface
+ */
+declare type ScreenCapturePermission = {
+    permission: ScreenCaptureBehavior;
+    permissions: ScreenCaptureState[];
+};
+
+/**
+ * screenCapture state for a given entity as defined in domain settings.
+ * @interface
+ */
+declare type ScreenCaptureState = {
+    info: EntityInfo;
+    behavior: ScreenCaptureBehavior;
+    url: string;
+};
+
 /**
  * @interface
  */
@@ -17673,6 +17708,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
+    /**
+     *
+     * Get the screen capture permission for this content.
+     *
+     * @example
+     * ```js
+     * const { permission } = await fin.me.getScreenCapturePermission();
+     *
+     * console.log(`This content is currently ${permission}ed in screen captures.`);
+     *
+     * ```
+     */
+    getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
 }
 
 /**

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

@@ -5932,11 +5932,8 @@ declare type FrameEventType = EventType_5;
 /**
  * @interface
  */
-declare type FrameInfo = {
-    name: string;
-    uuid: string;
+declare type FrameInfo = EntityInfo & {
     url: string;
-    entityType: EntityType_4;
     parent: Identity_4;
 };
 
@@ -9632,6 +9629,8 @@ declare namespace OpenFin {
         ClientConnectionPayload,
         EntityInfo,
         EntityType_4 as EntityType,
+        ScreenCaptureState,
+        ScreenCapturePermission,
         Bounds,
         WindowBounds,
         Rectangle,
@@ -9851,6 +9850,7 @@ declare namespace OpenFin {
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
+        ScreenCaptureBehavior,
         PerDomainSettings,
         DomainSettingsRule,
         FileDownloadBehavior,
@@ -10164,6 +10164,12 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    contentProtection?: {
+        /**
+         * {@inheritdoc ScreenCaptureBehavior}
+         */
+        screenCapture: ScreenCaptureBehavior;
+    };
 };
 
 /**
@@ -12809,6 +12815,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.PopupResult;
     };
+    'get-screen-capture-permissions': {
+        request: OpenFin.Identity;
+        response: OpenFin.ScreenCapturePermission;
+    };
     'render-overlay': {
         request: {
             bounds: OpenFin.Bounds;
@@ -13338,6 +13348,31 @@ declare type RvmLaunchOptions = {
     subscribe?: (launch: LaunchEmitter) => void;
 };
 
+/**
+ * @interface
+ * Controls whether this content should be allowed or blocked when capturing the screen.
+ */
+declare type ScreenCaptureBehavior = 'allow' | 'block';
+
+/**
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
+ * @interface
+ */
+declare type ScreenCapturePermission = {
+    permission: ScreenCaptureBehavior;
+    permissions: ScreenCaptureState[];
+};
+
+/**
+ * screenCapture state for a given entity as defined in domain settings.
+ * @interface
+ */
+declare type ScreenCaptureState = {
+    info: EntityInfo;
+    behavior: ScreenCaptureBehavior;
+    url: string;
+};
+
 /**
  * @interface
  */
@@ -17673,6 +17708,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
+    /**
+     *
+     * Get the screen capture permission for this content.
+     *
+     * @example
+     * ```js
+     * const { permission } = await fin.me.getScreenCapturePermission();
+     *
+     * console.log(`This content is currently ${permission}ed in screen captures.`);
+     *
+     * ```
+     */
+    getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
 }
 
 /**

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

@@ -5932,11 +5932,8 @@ declare type FrameEventType = EventType_5;
 /**
  * @interface
  */
-declare type FrameInfo = {
-    name: string;
-    uuid: string;
+declare type FrameInfo = EntityInfo & {
     url: string;
-    entityType: EntityType_4;
     parent: Identity_4;
 };
 
@@ -9632,6 +9629,8 @@ declare namespace OpenFin {
         ClientConnectionPayload,
         EntityInfo,
         EntityType_4 as EntityType,
+        ScreenCaptureState,
+        ScreenCapturePermission,
         Bounds,
         WindowBounds,
         Rectangle,
@@ -9851,6 +9850,7 @@ declare namespace OpenFin {
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
+        ScreenCaptureBehavior,
         PerDomainSettings,
         DomainSettingsRule,
         FileDownloadBehavior,
@@ -10164,6 +10164,12 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    contentProtection?: {
+        /**
+         * {@inheritdoc ScreenCaptureBehavior}
+         */
+        screenCapture: ScreenCaptureBehavior;
+    };
 };
 
 /**
@@ -12809,6 +12815,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.PopupResult;
     };
+    'get-screen-capture-permissions': {
+        request: OpenFin.Identity;
+        response: OpenFin.ScreenCapturePermission;
+    };
     'render-overlay': {
         request: {
             bounds: OpenFin.Bounds;
@@ -13338,6 +13348,31 @@ declare type RvmLaunchOptions = {
     subscribe?: (launch: LaunchEmitter) => void;
 };
 
+/**
+ * @interface
+ * Controls whether this content should be allowed or blocked when capturing the screen.
+ */
+declare type ScreenCaptureBehavior = 'allow' | 'block';
+
+/**
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
+ * @interface
+ */
+declare type ScreenCapturePermission = {
+    permission: ScreenCaptureBehavior;
+    permissions: ScreenCaptureState[];
+};
+
+/**
+ * screenCapture state for a given entity as defined in domain settings.
+ * @interface
+ */
+declare type ScreenCaptureState = {
+    info: EntityInfo;
+    behavior: ScreenCaptureBehavior;
+    url: string;
+};
+
 /**
  * @interface
  */
@@ -17673,6 +17708,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
+    /**
+     *
+     * Get the screen capture permission for this content.
+     *
+     * @example
+     * ```js
+     * const { permission } = await fin.me.getScreenCapturePermission();
+     *
+     * console.log(`This content is currently ${permission}ed in screen captures.`);
+     *
+     * ```
+     */
+    getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
 }
 
 /**

package/out/fdc3-api.d.ts

@@ -6020,11 +6020,8 @@ declare type FrameEventType = EventType_5;
 /**
  * @interface
  */
-declare type FrameInfo = {
-    name: string;
-    uuid: string;
+declare type FrameInfo = EntityInfo & {
     url: string;
-    entityType: EntityType_4;
     parent: Identity_4;
 };
 
@@ -9950,6 +9947,8 @@ declare namespace OpenFin {
         ClientConnectionPayload,
         EntityInfo,
         EntityType_4 as EntityType,
+        ScreenCaptureState,
+        ScreenCapturePermission,
         Bounds,
         WindowBounds,
         Rectangle,
@@ -10169,6 +10168,7 @@ declare namespace OpenFin {
         StructuredContentBehavior,
         StructuredContentPermissions,
         ContentPermission,
+        ScreenCaptureBehavior,
         PerDomainSettings,
         DomainSettingsRule,
         FileDownloadBehavior,
@@ -10482,6 +10482,12 @@ declare type PerDomainSettings = {
      * {@inheritdoc ChromiumPolicies}
      */
     chromiumPolicies?: ChromiumPolicies;
+    contentProtection?: {
+        /**
+         * {@inheritdoc ScreenCaptureBehavior}
+         */
+        screenCapture: ScreenCaptureBehavior;
+    };
 };
 
 /**
@@ -13210,6 +13216,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
         };
         response: OpenFin.PopupResult;
     };
+    'get-screen-capture-permissions': {
+        request: OpenFin.Identity;
+        response: OpenFin.ScreenCapturePermission;
+    };
     'render-overlay': {
         request: {
             bounds: OpenFin.Bounds;
@@ -13739,6 +13749,31 @@ declare type RvmLaunchOptions = {
     subscribe?: (launch: LaunchEmitter) => void;
 };
 
+/**
+ * @interface
+ * Controls whether this content should be allowed or blocked when capturing the screen.
+ */
+declare type ScreenCaptureBehavior = 'allow' | 'block';
+
+/**
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
+ * @interface
+ */
+declare type ScreenCapturePermission = {
+    permission: ScreenCaptureBehavior;
+    permissions: ScreenCaptureState[];
+};
+
+/**
+ * screenCapture state for a given entity as defined in domain settings.
+ * @interface
+ */
+declare type ScreenCaptureState = {
+    info: EntityInfo;
+    behavior: ScreenCaptureBehavior;
+    url: string;
+};
+
 /**
  * @interface
  */
@@ -18124,6 +18159,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
      * {@link OpenFin.WebContentsEvents event namespace}.
      */
     showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
+    /**
+     *
+     * Get the screen capture permission for this content.
+     *
+     * @example
+     * ```js
+     * const { permission } = await fin.me.getScreenCapturePermission();
+     *
+     * console.log(`This content is currently ${permission}ed in screen captures.`);
+     *
+     * ```
+     */
+    getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
 }
 
 /**

package/package.json

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