@openfin/core 41.100.28 → 41.100.29

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.
@@ -5590,11 +5590,8 @@ declare type FrameEventType = EventType_5;
5590
5590
  /**
5591
5591
  * @interface
5592
5592
  */
5593
- declare type FrameInfo = {
5594
- name: string;
5595
- uuid: string;
5593
+ declare type FrameInfo = EntityInfo & {
5596
5594
  url: string;
5597
- entityType: EntityType_4;
5598
5595
  parent: Identity_4;
5599
5596
  };
5600
5597
 
@@ -9290,6 +9287,8 @@ declare namespace OpenFin_2 {
9290
9287
  ClientConnectionPayload,
9291
9288
  EntityInfo,
9292
9289
  EntityType_4 as EntityType,
9290
+ ScreenCaptureState,
9291
+ ScreenCapturePermission,
9293
9292
  Bounds,
9294
9293
  WindowBounds,
9295
9294
  Rectangle,
@@ -9509,6 +9508,7 @@ declare namespace OpenFin_2 {
9509
9508
  StructuredContentBehavior,
9510
9509
  StructuredContentPermissions,
9511
9510
  ContentPermission,
9511
+ ScreenCaptureBehavior,
9512
9512
  PerDomainSettings,
9513
9513
  DomainSettingsRule,
9514
9514
  FileDownloadBehavior,
@@ -9824,6 +9824,12 @@ declare type PerDomainSettings = {
9824
9824
  * {@inheritdoc ChromiumPolicies}
9825
9825
  */
9826
9826
  chromiumPolicies?: ChromiumPolicies;
9827
+ contentProtection?: {
9828
+ /**
9829
+ * {@inheritdoc ScreenCaptureBehavior}
9830
+ */
9831
+ screenCapture: ScreenCaptureBehavior;
9832
+ };
9827
9833
  };
9828
9834
 
9829
9835
  /**
@@ -12469,6 +12475,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12469
12475
  };
12470
12476
  response: OpenFin_2.PopupResult;
12471
12477
  };
12478
+ 'get-screen-capture-permissions': {
12479
+ request: OpenFin_2.Identity;
12480
+ response: OpenFin_2.ScreenCapturePermission;
12481
+ };
12472
12482
  'render-overlay': {
12473
12483
  request: {
12474
12484
  bounds: OpenFin_2.Bounds;
@@ -12998,6 +13008,31 @@ declare type RvmLaunchOptions = {
12998
13008
  subscribe?: (launch: LaunchEmitter) => void;
12999
13009
  };
13000
13010
 
13011
+ /**
13012
+ * @interface
13013
+ * Controls whether this content should be allowed or blocked when capturing the screen.
13014
+ */
13015
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13016
+
13017
+ /**
13018
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13019
+ * @interface
13020
+ */
13021
+ declare type ScreenCapturePermission = {
13022
+ permission: ScreenCaptureBehavior;
13023
+ permissions: ScreenCaptureState[];
13024
+ };
13025
+
13026
+ /**
13027
+ * screenCapture state for a given entity as defined in domain settings.
13028
+ * @interface
13029
+ */
13030
+ declare type ScreenCaptureState = {
13031
+ info: EntityInfo;
13032
+ behavior: ScreenCaptureBehavior;
13033
+ url: string;
13034
+ };
13035
+
13001
13036
  /**
13002
13037
  * @interface
13003
13038
  */
@@ -17227,6 +17262,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17227
17262
  * {@link OpenFin.WebContentsEvents event namespace}.
17228
17263
  */
17229
17264
  showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
17265
+ /**
17266
+ *
17267
+ * Get the screen capture permission for this content.
17268
+ *
17269
+ * @example
17270
+ * ```js
17271
+ * const { permission } = await fin.me.getScreenCapturePermission();
17272
+ *
17273
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
17274
+ *
17275
+ * ```
17276
+ */
17277
+ getScreenCapturePermission(): Promise<OpenFin_2.ScreenCapturePermission>;
17230
17278
  }
17231
17279
 
17232
17280
  /**
@@ -5590,11 +5590,8 @@ declare type FrameEventType = EventType_5;
5590
5590
  /**
5591
5591
  * @interface
5592
5592
  */
5593
- declare type FrameInfo = {
5594
- name: string;
5595
- uuid: string;
5593
+ declare type FrameInfo = EntityInfo & {
5596
5594
  url: string;
5597
- entityType: EntityType_4;
5598
5595
  parent: Identity_4;
5599
5596
  };
5600
5597
 
@@ -9290,6 +9287,8 @@ declare namespace OpenFin_2 {
9290
9287
  ClientConnectionPayload,
9291
9288
  EntityInfo,
9292
9289
  EntityType_4 as EntityType,
9290
+ ScreenCaptureState,
9291
+ ScreenCapturePermission,
9293
9292
  Bounds,
9294
9293
  WindowBounds,
9295
9294
  Rectangle,
@@ -9509,6 +9508,7 @@ declare namespace OpenFin_2 {
9509
9508
  StructuredContentBehavior,
9510
9509
  StructuredContentPermissions,
9511
9510
  ContentPermission,
9511
+ ScreenCaptureBehavior,
9512
9512
  PerDomainSettings,
9513
9513
  DomainSettingsRule,
9514
9514
  FileDownloadBehavior,
@@ -9824,6 +9824,12 @@ declare type PerDomainSettings = {
9824
9824
  * {@inheritdoc ChromiumPolicies}
9825
9825
  */
9826
9826
  chromiumPolicies?: ChromiumPolicies;
9827
+ contentProtection?: {
9828
+ /**
9829
+ * {@inheritdoc ScreenCaptureBehavior}
9830
+ */
9831
+ screenCapture: ScreenCaptureBehavior;
9832
+ };
9827
9833
  };
9828
9834
 
9829
9835
  /**
@@ -12469,6 +12475,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12469
12475
  };
12470
12476
  response: OpenFin_2.PopupResult;
12471
12477
  };
12478
+ 'get-screen-capture-permissions': {
12479
+ request: OpenFin_2.Identity;
12480
+ response: OpenFin_2.ScreenCapturePermission;
12481
+ };
12472
12482
  'render-overlay': {
12473
12483
  request: {
12474
12484
  bounds: OpenFin_2.Bounds;
@@ -12998,6 +13008,31 @@ declare type RvmLaunchOptions = {
12998
13008
  subscribe?: (launch: LaunchEmitter) => void;
12999
13009
  };
13000
13010
 
13011
+ /**
13012
+ * @interface
13013
+ * Controls whether this content should be allowed or blocked when capturing the screen.
13014
+ */
13015
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13016
+
13017
+ /**
13018
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13019
+ * @interface
13020
+ */
13021
+ declare type ScreenCapturePermission = {
13022
+ permission: ScreenCaptureBehavior;
13023
+ permissions: ScreenCaptureState[];
13024
+ };
13025
+
13026
+ /**
13027
+ * screenCapture state for a given entity as defined in domain settings.
13028
+ * @interface
13029
+ */
13030
+ declare type ScreenCaptureState = {
13031
+ info: EntityInfo;
13032
+ behavior: ScreenCaptureBehavior;
13033
+ url: string;
13034
+ };
13035
+
13001
13036
  /**
13002
13037
  * @interface
13003
13038
  */
@@ -17227,6 +17262,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17227
17262
  * {@link OpenFin.WebContentsEvents event namespace}.
17228
17263
  */
17229
17264
  showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
17265
+ /**
17266
+ *
17267
+ * Get the screen capture permission for this content.
17268
+ *
17269
+ * @example
17270
+ * ```js
17271
+ * const { permission } = await fin.me.getScreenCapturePermission();
17272
+ *
17273
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
17274
+ *
17275
+ * ```
17276
+ */
17277
+ getScreenCapturePermission(): Promise<OpenFin_2.ScreenCapturePermission>;
17230
17278
  }
17231
17279
 
17232
17280
  /**
@@ -5590,11 +5590,8 @@ declare type FrameEventType = EventType_5;
5590
5590
  /**
5591
5591
  * @interface
5592
5592
  */
5593
- declare type FrameInfo = {
5594
- name: string;
5595
- uuid: string;
5593
+ declare type FrameInfo = EntityInfo & {
5596
5594
  url: string;
5597
- entityType: EntityType_4;
5598
5595
  parent: Identity_4;
5599
5596
  };
5600
5597
 
@@ -9290,6 +9287,8 @@ declare namespace OpenFin_2 {
9290
9287
  ClientConnectionPayload,
9291
9288
  EntityInfo,
9292
9289
  EntityType_4 as EntityType,
9290
+ ScreenCaptureState,
9291
+ ScreenCapturePermission,
9293
9292
  Bounds,
9294
9293
  WindowBounds,
9295
9294
  Rectangle,
@@ -9509,6 +9508,7 @@ declare namespace OpenFin_2 {
9509
9508
  StructuredContentBehavior,
9510
9509
  StructuredContentPermissions,
9511
9510
  ContentPermission,
9511
+ ScreenCaptureBehavior,
9512
9512
  PerDomainSettings,
9513
9513
  DomainSettingsRule,
9514
9514
  FileDownloadBehavior,
@@ -9824,6 +9824,12 @@ declare type PerDomainSettings = {
9824
9824
  * {@inheritdoc ChromiumPolicies}
9825
9825
  */
9826
9826
  chromiumPolicies?: ChromiumPolicies;
9827
+ contentProtection?: {
9828
+ /**
9829
+ * {@inheritdoc ScreenCaptureBehavior}
9830
+ */
9831
+ screenCapture: ScreenCaptureBehavior;
9832
+ };
9827
9833
  };
9828
9834
 
9829
9835
  /**
@@ -12469,6 +12475,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12469
12475
  };
12470
12476
  response: OpenFin_2.PopupResult;
12471
12477
  };
12478
+ 'get-screen-capture-permissions': {
12479
+ request: OpenFin_2.Identity;
12480
+ response: OpenFin_2.ScreenCapturePermission;
12481
+ };
12472
12482
  'render-overlay': {
12473
12483
  request: {
12474
12484
  bounds: OpenFin_2.Bounds;
@@ -12998,6 +13008,31 @@ declare type RvmLaunchOptions = {
12998
13008
  subscribe?: (launch: LaunchEmitter) => void;
12999
13009
  };
13000
13010
 
13011
+ /**
13012
+ * @interface
13013
+ * Controls whether this content should be allowed or blocked when capturing the screen.
13014
+ */
13015
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13016
+
13017
+ /**
13018
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13019
+ * @interface
13020
+ */
13021
+ declare type ScreenCapturePermission = {
13022
+ permission: ScreenCaptureBehavior;
13023
+ permissions: ScreenCaptureState[];
13024
+ };
13025
+
13026
+ /**
13027
+ * screenCapture state for a given entity as defined in domain settings.
13028
+ * @interface
13029
+ */
13030
+ declare type ScreenCaptureState = {
13031
+ info: EntityInfo;
13032
+ behavior: ScreenCaptureBehavior;
13033
+ url: string;
13034
+ };
13035
+
13001
13036
  /**
13002
13037
  * @interface
13003
13038
  */
@@ -17227,6 +17262,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17227
17262
  * {@link OpenFin.WebContentsEvents event namespace}.
17228
17263
  */
17229
17264
  showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
17265
+ /**
17266
+ *
17267
+ * Get the screen capture permission for this content.
17268
+ *
17269
+ * @example
17270
+ * ```js
17271
+ * const { permission } = await fin.me.getScreenCapturePermission();
17272
+ *
17273
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
17274
+ *
17275
+ * ```
17276
+ */
17277
+ getScreenCapturePermission(): Promise<OpenFin_2.ScreenCapturePermission>;
17230
17278
  }
17231
17279
 
17232
17280
  /**
package/out/mock.d.ts CHANGED
@@ -5678,11 +5678,8 @@ declare type FrameEventType = EventType_5;
5678
5678
  /**
5679
5679
  * @interface
5680
5680
  */
5681
- declare type FrameInfo = {
5682
- name: string;
5683
- uuid: string;
5681
+ declare type FrameInfo = EntityInfo & {
5684
5682
  url: string;
5685
- entityType: EntityType_4;
5686
5683
  parent: Identity_4;
5687
5684
  };
5688
5685
 
@@ -9608,6 +9605,8 @@ declare namespace OpenFin_2 {
9608
9605
  ClientConnectionPayload,
9609
9606
  EntityInfo,
9610
9607
  EntityType_4 as EntityType,
9608
+ ScreenCaptureState,
9609
+ ScreenCapturePermission,
9611
9610
  Bounds,
9612
9611
  WindowBounds,
9613
9612
  Rectangle,
@@ -9827,6 +9826,7 @@ declare namespace OpenFin_2 {
9827
9826
  StructuredContentBehavior,
9828
9827
  StructuredContentPermissions,
9829
9828
  ContentPermission,
9829
+ ScreenCaptureBehavior,
9830
9830
  PerDomainSettings,
9831
9831
  DomainSettingsRule,
9832
9832
  FileDownloadBehavior,
@@ -10142,6 +10142,12 @@ declare type PerDomainSettings = {
10142
10142
  * {@inheritdoc ChromiumPolicies}
10143
10143
  */
10144
10144
  chromiumPolicies?: ChromiumPolicies;
10145
+ contentProtection?: {
10146
+ /**
10147
+ * {@inheritdoc ScreenCaptureBehavior}
10148
+ */
10149
+ screenCapture: ScreenCaptureBehavior;
10150
+ };
10145
10151
  };
10146
10152
 
10147
10153
  /**
@@ -12870,6 +12876,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12870
12876
  };
12871
12877
  response: OpenFin_2.PopupResult;
12872
12878
  };
12879
+ 'get-screen-capture-permissions': {
12880
+ request: OpenFin_2.Identity;
12881
+ response: OpenFin_2.ScreenCapturePermission;
12882
+ };
12873
12883
  'render-overlay': {
12874
12884
  request: {
12875
12885
  bounds: OpenFin_2.Bounds;
@@ -13399,6 +13409,31 @@ declare type RvmLaunchOptions = {
13399
13409
  subscribe?: (launch: LaunchEmitter) => void;
13400
13410
  };
13401
13411
 
13412
+ /**
13413
+ * @interface
13414
+ * Controls whether this content should be allowed or blocked when capturing the screen.
13415
+ */
13416
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13417
+
13418
+ /**
13419
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13420
+ * @interface
13421
+ */
13422
+ declare type ScreenCapturePermission = {
13423
+ permission: ScreenCaptureBehavior;
13424
+ permissions: ScreenCaptureState[];
13425
+ };
13426
+
13427
+ /**
13428
+ * screenCapture state for a given entity as defined in domain settings.
13429
+ * @interface
13430
+ */
13431
+ declare type ScreenCaptureState = {
13432
+ info: EntityInfo;
13433
+ behavior: ScreenCaptureBehavior;
13434
+ url: string;
13435
+ };
13436
+
13402
13437
  /**
13403
13438
  * @interface
13404
13439
  */
@@ -17678,6 +17713,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17678
17713
  * {@link OpenFin.WebContentsEvents event namespace}.
17679
17714
  */
17680
17715
  showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
17716
+ /**
17717
+ *
17718
+ * Get the screen capture permission for this content.
17719
+ *
17720
+ * @example
17721
+ * ```js
17722
+ * const { permission } = await fin.me.getScreenCapturePermission();
17723
+ *
17724
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
17725
+ *
17726
+ * ```
17727
+ */
17728
+ getScreenCapturePermission(): Promise<OpenFin_2.ScreenCapturePermission>;
17681
17729
  }
17682
17730
 
17683
17731
  /**
package/out/mock.js CHANGED
@@ -2123,6 +2123,21 @@ class WebContents extends base_1$j.EmitterBase {
2123
2123
  });
2124
2124
  return payload.data;
2125
2125
  }
2126
+ /**
2127
+ *
2128
+ * Get the screen capture permission for this content.
2129
+ *
2130
+ * @example
2131
+ * ```js
2132
+ * const { permission } = await fin.me.getScreenCapturePermission();
2133
+ *
2134
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
2135
+ *
2136
+ * ```
2137
+ */
2138
+ async getScreenCapturePermission() {
2139
+ return (await this.wire.sendAction('get-screen-capture-permissions', this.identity)).payload.data;
2140
+ }
2126
2141
  }
2127
2142
  main.WebContents = WebContents;
2128
2143
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "41.100.28",
3
+ "version": "41.100.29",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",