@openfin/fdc3-api 41.100.28 → 41.100.30

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.
@@ -5250,6 +5250,10 @@ declare namespace FDC3 {
5250
5250
  }
5251
5251
  }
5252
5252
 
5253
+ declare type FDC3Factory = typeof fdc3Factory;
5254
+
5255
+ declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
5256
+
5253
5257
  export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
5254
5258
  fdc3Version?: Fdc3Version;
5255
5259
  }): Promise<Fdc3Module | Fdc3Module2>;
@@ -5932,11 +5936,8 @@ declare type FrameEventType = EventType_5;
5932
5936
  /**
5933
5937
  * @interface
5934
5938
  */
5935
- declare type FrameInfo = {
5936
- name: string;
5937
- uuid: string;
5939
+ declare type FrameInfo = EntityInfo & {
5938
5940
  url: string;
5939
- entityType: EntityType_4;
5940
5941
  parent: Identity_4;
5941
5942
  };
5942
5943
 
@@ -7225,7 +7226,7 @@ declare class InteropBroker extends Base {
7225
7226
  };
7226
7227
  private getClientState;
7227
7228
  private static toObject;
7228
- static checkContextIntegrity(context: OpenFin.Context): {
7229
+ static checkContextIntegrity: (context: OpenFin.Context) => {
7229
7230
  isValid: true;
7230
7231
  } | {
7231
7232
  isValid: false;
@@ -8248,6 +8249,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
8248
8249
 
8249
8250
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
8250
8251
 
8252
+ /**
8253
+ * Generated after a layout is created.
8254
+ * @interface
8255
+ */
8256
+ declare type LayoutCreatedEvent = BaseEvent_5 & {
8257
+ type: 'layout-created';
8258
+ layoutIdentity: OpenFin.LayoutIdentity;
8259
+ };
8260
+
8261
+ /**
8262
+ * Generated after a layout is destroyed.
8263
+ * @interface
8264
+ */
8265
+ declare type LayoutDestroyedEvent = BaseEvent_5 & {
8266
+ type: 'layout-destroyed';
8267
+ layoutIdentity: OpenFin.LayoutIdentity;
8268
+ };
8269
+
8251
8270
  /**
8252
8271
  * The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
8253
8272
  */
@@ -8733,6 +8752,15 @@ declare type LayoutSnapshot = {
8733
8752
  layouts: Record<string, LayoutOptions>;
8734
8753
  };
8735
8754
 
8755
+ /**
8756
+ * Generated after a snapshot is applied.
8757
+ * @interface
8758
+ */
8759
+ declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
8760
+ type: 'layout-snapshot-applied';
8761
+ layoutIdentity: OpenFin.LayoutIdentity;
8762
+ };
8763
+
8736
8764
  /**
8737
8765
  * Generated when the Layout experiences a state change, for example tabs added/removed.
8738
8766
  * @interface
@@ -9632,6 +9660,8 @@ declare namespace OpenFin {
9632
9660
  ClientConnectionPayload,
9633
9661
  EntityInfo,
9634
9662
  EntityType_4 as EntityType,
9663
+ ScreenCaptureState,
9664
+ ScreenCapturePermission,
9635
9665
  Bounds,
9636
9666
  WindowBounds,
9637
9667
  Rectangle,
@@ -9851,6 +9881,7 @@ declare namespace OpenFin {
9851
9881
  StructuredContentBehavior,
9852
9882
  StructuredContentPermissions,
9853
9883
  ContentPermission,
9884
+ ScreenCaptureBehavior,
9854
9885
  PerDomainSettings,
9855
9886
  DomainSettingsRule,
9856
9887
  FileDownloadBehavior,
@@ -10164,6 +10195,12 @@ declare type PerDomainSettings = {
10164
10195
  * {@inheritdoc ChromiumPolicies}
10165
10196
  */
10166
10197
  chromiumPolicies?: ChromiumPolicies;
10198
+ contentProtection?: {
10199
+ /**
10200
+ * {@inheritdoc ScreenCaptureBehavior}
10201
+ */
10202
+ screenCapture: ScreenCaptureBehavior;
10203
+ };
10167
10204
  };
10168
10205
 
10169
10206
  /**
@@ -12809,6 +12846,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12809
12846
  };
12810
12847
  response: OpenFin.PopupResult;
12811
12848
  };
12849
+ 'get-screen-capture-permissions': {
12850
+ request: OpenFin.Identity;
12851
+ response: OpenFin.ScreenCapturePermission;
12852
+ };
12812
12853
  'render-overlay': {
12813
12854
  request: {
12814
12855
  bounds: OpenFin.Bounds;
@@ -13338,6 +13379,31 @@ declare type RvmLaunchOptions = {
13338
13379
  subscribe?: (launch: LaunchEmitter) => void;
13339
13380
  };
13340
13381
 
13382
+ /**
13383
+ * @interface
13384
+ * Controls whether this content should be allowed or blocked when capturing the screen.
13385
+ */
13386
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13387
+
13388
+ /**
13389
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13390
+ * @interface
13391
+ */
13392
+ declare type ScreenCapturePermission = {
13393
+ permission: ScreenCaptureBehavior;
13394
+ permissions: ScreenCaptureState[];
13395
+ };
13396
+
13397
+ /**
13398
+ * screenCapture state for a given entity as defined in domain settings.
13399
+ * @interface
13400
+ */
13401
+ declare type ScreenCaptureState = {
13402
+ info: EntityInfo;
13403
+ behavior: ScreenCaptureBehavior;
13404
+ url: string;
13405
+ };
13406
+
13341
13407
  /**
13342
13408
  * @interface
13343
13409
  */
@@ -17673,6 +17739,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17673
17739
  * {@link OpenFin.WebContentsEvents event namespace}.
17674
17740
  */
17675
17741
  showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
17742
+ /**
17743
+ *
17744
+ * Get the screen capture permission for this content.
17745
+ *
17746
+ * @example
17747
+ * ```js
17748
+ * const { permission } = await fin.me.getScreenCapturePermission();
17749
+ *
17750
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
17751
+ *
17752
+ * ```
17753
+ */
17754
+ getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
17676
17755
  }
17677
17756
 
17678
17757
  /**
@@ -18986,6 +19065,9 @@ declare namespace WindowEvents {
18986
19065
  PerformanceReportEvent,
18987
19066
  InputEvent_2 as InputEvent,
18988
19067
  LayoutInitializedEvent,
19068
+ LayoutCreatedEvent,
19069
+ LayoutDestroyedEvent,
19070
+ LayoutSnapshotAppliedEvent,
18989
19071
  LayoutReadyEvent,
18990
19072
  CloseRequestedEvent,
18991
19073
  WindowCloseRequestedEvent,
@@ -19219,7 +19301,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19219
19301
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19220
19302
  * from {@link OpenFin.ViewEvents}.
19221
19303
  */
19222
- declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19304
+ declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19223
19305
 
19224
19306
  /**
19225
19307
  * Generated when a child window starts loading.
@@ -5250,6 +5250,10 @@ declare namespace FDC3 {
5250
5250
  }
5251
5251
  }
5252
5252
 
5253
+ declare type FDC3Factory = typeof fdc3Factory;
5254
+
5255
+ declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
5256
+
5253
5257
  export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
5254
5258
  fdc3Version?: Fdc3Version;
5255
5259
  }): Promise<Fdc3Module | Fdc3Module2>;
@@ -5932,11 +5936,8 @@ declare type FrameEventType = EventType_5;
5932
5936
  /**
5933
5937
  * @interface
5934
5938
  */
5935
- declare type FrameInfo = {
5936
- name: string;
5937
- uuid: string;
5939
+ declare type FrameInfo = EntityInfo & {
5938
5940
  url: string;
5939
- entityType: EntityType_4;
5940
5941
  parent: Identity_4;
5941
5942
  };
5942
5943
 
@@ -7225,7 +7226,7 @@ declare class InteropBroker extends Base {
7225
7226
  };
7226
7227
  private getClientState;
7227
7228
  private static toObject;
7228
- static checkContextIntegrity(context: OpenFin.Context): {
7229
+ static checkContextIntegrity: (context: OpenFin.Context) => {
7229
7230
  isValid: true;
7230
7231
  } | {
7231
7232
  isValid: false;
@@ -8248,6 +8249,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
8248
8249
 
8249
8250
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
8250
8251
 
8252
+ /**
8253
+ * Generated after a layout is created.
8254
+ * @interface
8255
+ */
8256
+ declare type LayoutCreatedEvent = BaseEvent_5 & {
8257
+ type: 'layout-created';
8258
+ layoutIdentity: OpenFin.LayoutIdentity;
8259
+ };
8260
+
8261
+ /**
8262
+ * Generated after a layout is destroyed.
8263
+ * @interface
8264
+ */
8265
+ declare type LayoutDestroyedEvent = BaseEvent_5 & {
8266
+ type: 'layout-destroyed';
8267
+ layoutIdentity: OpenFin.LayoutIdentity;
8268
+ };
8269
+
8251
8270
  /**
8252
8271
  * The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
8253
8272
  */
@@ -8733,6 +8752,15 @@ declare type LayoutSnapshot = {
8733
8752
  layouts: Record<string, LayoutOptions>;
8734
8753
  };
8735
8754
 
8755
+ /**
8756
+ * Generated after a snapshot is applied.
8757
+ * @interface
8758
+ */
8759
+ declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
8760
+ type: 'layout-snapshot-applied';
8761
+ layoutIdentity: OpenFin.LayoutIdentity;
8762
+ };
8763
+
8736
8764
  /**
8737
8765
  * Generated when the Layout experiences a state change, for example tabs added/removed.
8738
8766
  * @interface
@@ -9632,6 +9660,8 @@ declare namespace OpenFin {
9632
9660
  ClientConnectionPayload,
9633
9661
  EntityInfo,
9634
9662
  EntityType_4 as EntityType,
9663
+ ScreenCaptureState,
9664
+ ScreenCapturePermission,
9635
9665
  Bounds,
9636
9666
  WindowBounds,
9637
9667
  Rectangle,
@@ -9851,6 +9881,7 @@ declare namespace OpenFin {
9851
9881
  StructuredContentBehavior,
9852
9882
  StructuredContentPermissions,
9853
9883
  ContentPermission,
9884
+ ScreenCaptureBehavior,
9854
9885
  PerDomainSettings,
9855
9886
  DomainSettingsRule,
9856
9887
  FileDownloadBehavior,
@@ -10164,6 +10195,12 @@ declare type PerDomainSettings = {
10164
10195
  * {@inheritdoc ChromiumPolicies}
10165
10196
  */
10166
10197
  chromiumPolicies?: ChromiumPolicies;
10198
+ contentProtection?: {
10199
+ /**
10200
+ * {@inheritdoc ScreenCaptureBehavior}
10201
+ */
10202
+ screenCapture: ScreenCaptureBehavior;
10203
+ };
10167
10204
  };
10168
10205
 
10169
10206
  /**
@@ -12809,6 +12846,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12809
12846
  };
12810
12847
  response: OpenFin.PopupResult;
12811
12848
  };
12849
+ 'get-screen-capture-permissions': {
12850
+ request: OpenFin.Identity;
12851
+ response: OpenFin.ScreenCapturePermission;
12852
+ };
12812
12853
  'render-overlay': {
12813
12854
  request: {
12814
12855
  bounds: OpenFin.Bounds;
@@ -13338,6 +13379,31 @@ declare type RvmLaunchOptions = {
13338
13379
  subscribe?: (launch: LaunchEmitter) => void;
13339
13380
  };
13340
13381
 
13382
+ /**
13383
+ * @interface
13384
+ * Controls whether this content should be allowed or blocked when capturing the screen.
13385
+ */
13386
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13387
+
13388
+ /**
13389
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13390
+ * @interface
13391
+ */
13392
+ declare type ScreenCapturePermission = {
13393
+ permission: ScreenCaptureBehavior;
13394
+ permissions: ScreenCaptureState[];
13395
+ };
13396
+
13397
+ /**
13398
+ * screenCapture state for a given entity as defined in domain settings.
13399
+ * @interface
13400
+ */
13401
+ declare type ScreenCaptureState = {
13402
+ info: EntityInfo;
13403
+ behavior: ScreenCaptureBehavior;
13404
+ url: string;
13405
+ };
13406
+
13341
13407
  /**
13342
13408
  * @interface
13343
13409
  */
@@ -17673,6 +17739,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17673
17739
  * {@link OpenFin.WebContentsEvents event namespace}.
17674
17740
  */
17675
17741
  showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
17742
+ /**
17743
+ *
17744
+ * Get the screen capture permission for this content.
17745
+ *
17746
+ * @example
17747
+ * ```js
17748
+ * const { permission } = await fin.me.getScreenCapturePermission();
17749
+ *
17750
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
17751
+ *
17752
+ * ```
17753
+ */
17754
+ getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
17676
17755
  }
17677
17756
 
17678
17757
  /**
@@ -18986,6 +19065,9 @@ declare namespace WindowEvents {
18986
19065
  PerformanceReportEvent,
18987
19066
  InputEvent_2 as InputEvent,
18988
19067
  LayoutInitializedEvent,
19068
+ LayoutCreatedEvent,
19069
+ LayoutDestroyedEvent,
19070
+ LayoutSnapshotAppliedEvent,
18989
19071
  LayoutReadyEvent,
18990
19072
  CloseRequestedEvent,
18991
19073
  WindowCloseRequestedEvent,
@@ -19219,7 +19301,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19219
19301
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19220
19302
  * from {@link OpenFin.ViewEvents}.
19221
19303
  */
19222
- declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19304
+ declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19223
19305
 
19224
19306
  /**
19225
19307
  * Generated when a child window starts loading.
@@ -5250,6 +5250,10 @@ declare namespace FDC3 {
5250
5250
  }
5251
5251
  }
5252
5252
 
5253
+ declare type FDC3Factory = typeof fdc3Factory;
5254
+
5255
+ declare const fdc3Factory: (version: '1.2' | '2.0', interopClient: OpenFin.InteropClient, wire: Transport<'unknown'>) => OpenFin.FDC3.v2_0.DesktopAgent | OpenFin.FDC3.v1_2.DesktopAgent;
5256
+
5253
5257
  export declare function fdc3FromFin(fin: OpenFin.Fin<OpenFin.EntityType>, { fdc3Version }?: {
5254
5258
  fdc3Version?: Fdc3Version;
5255
5259
  }): Promise<Fdc3Module | Fdc3Module2>;
@@ -5932,11 +5936,8 @@ declare type FrameEventType = EventType_5;
5932
5936
  /**
5933
5937
  * @interface
5934
5938
  */
5935
- declare type FrameInfo = {
5936
- name: string;
5937
- uuid: string;
5939
+ declare type FrameInfo = EntityInfo & {
5938
5940
  url: string;
5939
- entityType: EntityType_4;
5940
5941
  parent: Identity_4;
5941
5942
  };
5942
5943
 
@@ -7225,7 +7226,7 @@ declare class InteropBroker extends Base {
7225
7226
  };
7226
7227
  private getClientState;
7227
7228
  private static toObject;
7228
- static checkContextIntegrity(context: OpenFin.Context): {
7229
+ static checkContextIntegrity: (context: OpenFin.Context) => {
7229
7230
  isValid: true;
7230
7231
  } | {
7231
7232
  isValid: false;
@@ -8248,6 +8249,24 @@ declare type LayoutComponent = Omit<LayoutItemConfig, 'content' | 'type'> & {
8248
8249
 
8249
8250
  declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent>;
8250
8251
 
8252
+ /**
8253
+ * Generated after a layout is created.
8254
+ * @interface
8255
+ */
8256
+ declare type LayoutCreatedEvent = BaseEvent_5 & {
8257
+ type: 'layout-created';
8258
+ layoutIdentity: OpenFin.LayoutIdentity;
8259
+ };
8260
+
8261
+ /**
8262
+ * Generated after a layout is destroyed.
8263
+ * @interface
8264
+ */
8265
+ declare type LayoutDestroyedEvent = BaseEvent_5 & {
8266
+ type: 'layout-destroyed';
8267
+ layoutIdentity: OpenFin.LayoutIdentity;
8268
+ };
8269
+
8251
8270
  /**
8252
8271
  * The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
8253
8272
  */
@@ -8733,6 +8752,15 @@ declare type LayoutSnapshot = {
8733
8752
  layouts: Record<string, LayoutOptions>;
8734
8753
  };
8735
8754
 
8755
+ /**
8756
+ * Generated after a snapshot is applied.
8757
+ * @interface
8758
+ */
8759
+ declare type LayoutSnapshotAppliedEvent = BaseEvent_5 & {
8760
+ type: 'layout-snapshot-applied';
8761
+ layoutIdentity: OpenFin.LayoutIdentity;
8762
+ };
8763
+
8736
8764
  /**
8737
8765
  * Generated when the Layout experiences a state change, for example tabs added/removed.
8738
8766
  * @interface
@@ -9632,6 +9660,8 @@ declare namespace OpenFin {
9632
9660
  ClientConnectionPayload,
9633
9661
  EntityInfo,
9634
9662
  EntityType_4 as EntityType,
9663
+ ScreenCaptureState,
9664
+ ScreenCapturePermission,
9635
9665
  Bounds,
9636
9666
  WindowBounds,
9637
9667
  Rectangle,
@@ -9851,6 +9881,7 @@ declare namespace OpenFin {
9851
9881
  StructuredContentBehavior,
9852
9882
  StructuredContentPermissions,
9853
9883
  ContentPermission,
9884
+ ScreenCaptureBehavior,
9854
9885
  PerDomainSettings,
9855
9886
  DomainSettingsRule,
9856
9887
  FileDownloadBehavior,
@@ -10164,6 +10195,12 @@ declare type PerDomainSettings = {
10164
10195
  * {@inheritdoc ChromiumPolicies}
10165
10196
  */
10166
10197
  chromiumPolicies?: ChromiumPolicies;
10198
+ contentProtection?: {
10199
+ /**
10200
+ * {@inheritdoc ScreenCaptureBehavior}
10201
+ */
10202
+ screenCapture: ScreenCaptureBehavior;
10203
+ };
10167
10204
  };
10168
10205
 
10169
10206
  /**
@@ -12809,6 +12846,10 @@ declare interface ProtocolMap extends ProtocolMapBase {
12809
12846
  };
12810
12847
  response: OpenFin.PopupResult;
12811
12848
  };
12849
+ 'get-screen-capture-permissions': {
12850
+ request: OpenFin.Identity;
12851
+ response: OpenFin.ScreenCapturePermission;
12852
+ };
12812
12853
  'render-overlay': {
12813
12854
  request: {
12814
12855
  bounds: OpenFin.Bounds;
@@ -13338,6 +13379,31 @@ declare type RvmLaunchOptions = {
13338
13379
  subscribe?: (launch: LaunchEmitter) => void;
13339
13380
  };
13340
13381
 
13382
+ /**
13383
+ * @interface
13384
+ * Controls whether this content should be allowed or blocked when capturing the screen.
13385
+ */
13386
+ declare type ScreenCaptureBehavior = 'allow' | 'block';
13387
+
13388
+ /**
13389
+ * Returned by getScreenCapturePermission. Includes sub-entity permission states and the resulting permission.
13390
+ * @interface
13391
+ */
13392
+ declare type ScreenCapturePermission = {
13393
+ permission: ScreenCaptureBehavior;
13394
+ permissions: ScreenCaptureState[];
13395
+ };
13396
+
13397
+ /**
13398
+ * screenCapture state for a given entity as defined in domain settings.
13399
+ * @interface
13400
+ */
13401
+ declare type ScreenCaptureState = {
13402
+ info: EntityInfo;
13403
+ behavior: ScreenCaptureBehavior;
13404
+ url: string;
13405
+ };
13406
+
13341
13407
  /**
13342
13408
  * @interface
13343
13409
  */
@@ -17673,6 +17739,19 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
17673
17739
  * {@link OpenFin.WebContentsEvents event namespace}.
17674
17740
  */
17675
17741
  showPopupWindow(options: OpenFin.PopupOptions): Promise<OpenFin.PopupResult>;
17742
+ /**
17743
+ *
17744
+ * Get the screen capture permission for this content.
17745
+ *
17746
+ * @example
17747
+ * ```js
17748
+ * const { permission } = await fin.me.getScreenCapturePermission();
17749
+ *
17750
+ * console.log(`This content is currently ${permission}ed in screen captures.`);
17751
+ *
17752
+ * ```
17753
+ */
17754
+ getScreenCapturePermission(): Promise<OpenFin.ScreenCapturePermission>;
17676
17755
  }
17677
17756
 
17678
17757
  /**
@@ -18986,6 +19065,9 @@ declare namespace WindowEvents {
18986
19065
  PerformanceReportEvent,
18987
19066
  InputEvent_2 as InputEvent,
18988
19067
  LayoutInitializedEvent,
19068
+ LayoutCreatedEvent,
19069
+ LayoutDestroyedEvent,
19070
+ LayoutSnapshotAppliedEvent,
18989
19071
  LayoutReadyEvent,
18990
19072
  CloseRequestedEvent,
18991
19073
  WindowCloseRequestedEvent,
@@ -19219,7 +19301,7 @@ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19219
19301
  * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19220
19302
  * from {@link OpenFin.ViewEvents}.
19221
19303
  */
19222
- declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19304
+ declare type WindowSourcedEvent = WebContentsEvents.Event<'window'> | WindowViewEvent | AuthRequestedEvent | BeginUserBoundsChangingEvent | BoundsChangedEvent | BoundsChangingEvent | ContextChangedEvent | CloseRequestedEvent | ClosedEvent_2 | ClosingEvent | DisabledMovementBoundsChangedEvent | DisabledMovementBoundsChangingEvent | EmbeddedEvent | EndUserBoundsChangingEvent | ExternalProcessExitedEvent | ExternalProcessStartedEvent | HiddenEvent_2 | HotkeyEvent_2 | InitializedEvent_2 | LayoutInitializedEvent | LayoutReadyEvent | LayoutCreatedEvent | LayoutDestroyedEvent | LayoutSnapshotAppliedEvent | MaximizedEvent | MinimizedEvent | OptionsChangedEvent | PerformanceReportEvent | PreloadScriptsStateChangedEvent | PreloadScriptsStateChangingEvent | ReloadedEvent | RestoredEvent | ShowRequestedEvent | ShownEvent_2 | UserMovementDisabledEvent | UserMovementEnabledEvent | WillMoveEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19223
19305
 
19224
19306
  /**
19225
19307
  * Generated when a child window starts loading.