@openfin/node-adapter 34.78.66 → 35.78.3

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.
@@ -96,6 +96,10 @@ declare type Api = {
96
96
  sameOriginInjection?: boolean;
97
97
  enableDeprecatedSharedName?: boolean;
98
98
  };
99
+ /**
100
+ * Prevent fin API injection. If 'none', `fin` won't be available in this context.
101
+ */
102
+ fin?: InjectionType;
99
103
  };
100
104
 
101
105
  declare type ApiCall<Request, Response> = {
@@ -107,6 +111,13 @@ declare type ApiClient<T extends Record<any, any>> = {
107
111
  [key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
108
112
  };
109
113
 
114
+ /**
115
+ * @interface
116
+ */
117
+ declare type ApiInjection = {
118
+ fin: InjectionType;
119
+ };
120
+
110
121
  /**
111
122
  * Generated when a new Platform's API becomes responsive.
112
123
  * @interface
@@ -189,100 +200,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
189
200
  private window;
190
201
  /* Excluded from this release type: __constructor */
191
202
  private windowListFromIdentityList;
192
- /**
193
- * Adds a listener to the end of the listeners array for the specified event.
194
- * @param eventType - The type of the event.
195
- * @param listener - Called whenever an event of the specified type occurs.
196
- * @param options - Option to support event timestamps.
197
- *
198
- * @function addListener
199
- * @memberof Application
200
- * @instance
201
- * @tutorial Application.EventEmitter
202
- */
203
- /**
204
- * Adds a listener to the end of the listeners array for the specified event.
205
- * @param eventType - The type of the event.
206
- * @param listener - Called whenever an event of the specified type occurs.
207
- * @param options - Option to support event timestamps.
208
- *
209
- * @function on
210
- * @memberof Application
211
- * @instance
212
- * @tutorial Application.EventEmitter
213
- */
214
- /**
215
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
216
- * @param eventType - The type of the event.
217
- * @param listener - The callback function.
218
- * @param options - Option to support event timestamps.
219
- *
220
- * @function once
221
- * @memberof Application
222
- * @instance
223
- * @tutorial Application.EventEmitter
224
- */
225
- /**
226
- * Adds a listener to the beginning of the listeners array for the specified event.
227
- * @param eventType - The type of the event.
228
- * @param listener - The callback function.
229
- * @param options - Option to support event timestamps.
230
- *
231
- * @function prependListener
232
- * @memberof Application
233
- * @instance
234
- * @tutorial Application.EventEmitter
235
- */
236
- /**
237
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
238
- * The listener is added to the beginning of the listeners array.
239
- * @param eventType - The type of the event.
240
- * @param listener - The callback function.
241
- * @param options - Option to support event timestamps.
242
- *
243
- * @function prependOnceListener
244
- * @memberof Application
245
- * @instance
246
- * @tutorial Application.EventEmitter
247
- */
248
- /**
249
- * Remove a listener from the listener array for the specified event.
250
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
251
- * @param eventType - The type of the event.
252
- * @param listener - The callback function.
253
- * @param options - Option to support event timestamps.
254
- *
255
- * @function removeListener
256
- * @memberof Application
257
- * @instance
258
- * @tutorial Application.EventEmitter
259
- */
260
- /**
261
- * Removes all listeners, or those of the specified event.
262
- * @param eventType - The type of the event.
263
- *
264
- * @function removeAllListeners
265
- * @memberof Application
266
- * @instance
267
- * @tutorial Application.EventEmitter
268
- */
269
- /**
270
- * JumpListCategory interface
271
- * @typedef { object } JumpListCategory@typedef { object } JumpListCategory
272
- * @property { string } name The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.
273
- * @property { JumpListItem[] } items Array of JumpListItem objects
274
- */
275
- /**
276
- * @PORTED
277
- * JumpListItem interface
278
- * @typedef { object } JumpListItem@typedef { object } JumpListItem
279
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
280
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
281
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
282
- * @property { string } deepLink Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
283
- * @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
284
- * @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
285
- */
286
203
  /**
287
204
  * Determines if the application is currently running.
288
205
  *
@@ -929,6 +846,7 @@ declare namespace ApplicationEvents {
929
846
  RespondingEvent,
930
847
  StartedEvent,
931
848
  ApplicationSourcedEvent,
849
+ ApplicationSourcedEventType,
932
850
  Event_3 as Event,
933
851
  ApplicationEvent,
934
852
  EventType_3 as EventType,
@@ -1267,10 +1185,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1267
1185
  */
1268
1186
  apiDiagnostics: boolean;
1269
1187
  /**
1270
- * Define the file download rules.
1271
- * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
1188
+ * @deprecated Please use {@link domainSettings} instead
1272
1189
  */
1273
1190
  defaultDomainSettings: DefaultDomainSettings;
1191
+ /**
1192
+ * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
1193
+ */
1194
+ domainSettings: DomainSettings;
1274
1195
  /**
1275
1196
  * @defaultValue false
1276
1197
  *
@@ -1301,6 +1222,11 @@ declare type ApplicationPermissions = {
1301
1222
  */
1302
1223
  declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1303
1224
 
1225
+ /**
1226
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
1227
+ */
1228
+ declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
1229
+
1304
1230
  declare type ApplicationState = OpenFin.ApplicationState;
1305
1231
 
1306
1232
  /**
@@ -3104,20 +3030,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3104
3030
  connectionUrl: string;
3105
3031
  };
3106
3032
 
3107
- /**
3108
- * @PORTED
3109
- * WriteRequestType interface
3110
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3111
- * @property { string } data Data to be written
3112
- * @property { string } [type] Clipboard Type
3113
- */
3114
- /**
3115
- * @PORTED
3116
- * OpenFin.WriteAnyClipboardRequest interface
3117
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3118
- * @property { string } data Data to be written
3119
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3120
- */
3121
3033
  /**
3122
3034
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3123
3035
  *
@@ -4543,21 +4455,15 @@ declare type CustomRequestHeaders = {
4543
4455
  declare type DataChannelReadyState = RTCDataChannel['readyState'];
4544
4456
 
4545
4457
  /**
4458
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
4546
4459
  * @interface
4547
4460
  */
4548
- declare type DefaultDomainSettings = {
4549
- rules: DefaultDomainSettingsRule[];
4550
- };
4461
+ declare type DefaultDomainSettings = DomainSettings;
4551
4462
 
4552
4463
  /**
4553
- * @interface
4464
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4554
4465
  */
4555
- declare type DefaultDomainSettingsRule = {
4556
- match: string[];
4557
- options: {
4558
- downloadSettings: FileDownloadSettings;
4559
- };
4560
- };
4466
+ declare type DefaultDomainSettingsRule = DomainSettingsRule;
4561
4467
 
4562
4468
  declare interface DesktopAgent {
4563
4469
  open(app: TargetApp, context?: Context): Promise<void>;
@@ -4802,6 +4708,25 @@ declare type DisplayMetadata_3 = {
4802
4708
  readonly glyph?: string;
4803
4709
  };
4804
4710
 
4711
+ /**
4712
+ * @interface
4713
+ * Define the {@link https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads file download rules} and domain-based api injection rules.
4714
+ */
4715
+ declare type DomainSettings = {
4716
+ rules: DomainSettingsRule[];
4717
+ };
4718
+
4719
+ /**
4720
+ * @interface
4721
+ */
4722
+ declare type DomainSettingsRule = {
4723
+ match: string[];
4724
+ options: {
4725
+ downloadSettings?: FileDownloadSettings;
4726
+ api?: ApiInjection;
4727
+ };
4728
+ };
4729
+
4805
4730
  /**
4806
4731
  * Metadata returned from a preload script download request.
4807
4732
  *
@@ -5317,7 +5242,7 @@ declare type EventType_7 = Event_10['type'];
5317
5242
  /**
5318
5243
  * Union of possible `type` values for a {@link SystemEvent}.
5319
5244
  */
5320
- declare type EventType_8 = SystemEvent['type'];
5245
+ declare type EventType_8 = Event_11['type'];
5321
5246
 
5322
5247
  /* Excluded from this release type: EventWithId */
5323
5248
 
@@ -5349,83 +5274,6 @@ declare type ExitCode = {
5349
5274
  declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicationEvent> {
5350
5275
  identity: OpenFin.ApplicationIdentity;
5351
5276
  /* Excluded from this release type: __constructor */
5352
- /**
5353
- * Adds a listener to the end of the listeners array for the specified event.
5354
- * @param eventType - The type of the event.
5355
- * @param listener - Called whenever an event of the specified type occurs.
5356
- * @param options - Option to support event timestamps.
5357
- *
5358
- * @function addListener
5359
- * @memberof ExternalApplication
5360
- * @instance
5361
- * @tutorial ExternalApplication.EventEmitter
5362
- */
5363
- /**
5364
- * Adds a listener to the end of the listeners array for the specified event.
5365
- * @param eventType - The type of the event.
5366
- * @param listener - Called whenever an event of the specified type occurs.
5367
- * @param options - Option to support event timestamps.
5368
- *
5369
- * @function on
5370
- * @memberof ExternalApplication
5371
- * @instance
5372
- * @tutorial ExternalApplication.EventEmitter
5373
- */
5374
- /**
5375
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5376
- * @param eventType - The type of the event.
5377
- * @param listener - The callback function.
5378
- * @param options - Option to support event timestamps.
5379
- *
5380
- * @function once
5381
- * @memberof ExternalApplication
5382
- * @instance
5383
- * @tutorial ExternalApplication.EventEmitter
5384
- */
5385
- /**
5386
- * Adds a listener to the beginning of the listeners array for the specified event.
5387
- * @param eventType - The type of the event.
5388
- * @param listener - The callback function.
5389
- * @param options - Option to support event timestamps.
5390
- *
5391
- * @function prependListener
5392
- * @memberof ExternalApplication
5393
- * @instance
5394
- * @tutorial ExternalApplication.EventEmitter
5395
- */
5396
- /**
5397
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5398
- * The listener is added to the beginning of the listeners array.
5399
- * @param eventType - The type of the event.
5400
- * @param listener - The callback function.
5401
- * @param options - Option to support event timestamps.
5402
- *
5403
- * @function prependOnceListener
5404
- * @memberof ExternalApplication
5405
- * @instance
5406
- * @tutorial ExternalApplication.EventEmitter
5407
- */
5408
- /**
5409
- * Remove a listener from the listener array for the specified event.
5410
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5411
- * @param eventType - The type of the event.
5412
- * @param listener - The callback function.
5413
- * @param options - Option to support event timestamps.
5414
- *
5415
- * @function removeListener
5416
- * @memberof ExternalApplication
5417
- * @instance
5418
- * @tutorial ExternalApplication.EventEmitter
5419
- */
5420
- /**
5421
- * Removes all listeners, or those of the specified event.
5422
- * @param eventType - The type of the event.
5423
- *
5424
- * @function removeAllListeners
5425
- * @memberof ExternalApplication
5426
- * @instance
5427
- * @tutorial ExternalApplication.EventEmitter
5428
- */
5429
5277
  /**
5430
5278
  * Retrieves information about the external application.
5431
5279
  *
@@ -5845,83 +5693,6 @@ declare type FoundInPageEvent = NamedEvent & {
5845
5693
  declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5846
5694
  identity: OpenFin.Identity;
5847
5695
  /* Excluded from this release type: __constructor */
5848
- /**
5849
- * Adds the listener function to the end of the listeners array for the specified event type.
5850
- * @param eventType - The type of the event.
5851
- * @param listener - Called whenever an event of the specified type occurs.
5852
- * @param options - Option to support event timestamps.
5853
- *
5854
- * @function addListener
5855
- * @memberof Frame
5856
- * @instance
5857
- * @tutorial Frame.EventEmitter
5858
- */
5859
- /**
5860
- * Adds a listener to the end of the listeners array for the specified event.
5861
- * @param eventType - The type of the event.
5862
- * @param listener - Called whenever an event of the specified type occurs.
5863
- * @param options - Option to support event timestamps.
5864
- *
5865
- * @function on
5866
- * @memberof Frame
5867
- * @instance
5868
- * @tutorial Frame.EventEmitter
5869
- */
5870
- /**
5871
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5872
- * @param eventType - The type of the event.
5873
- * @param listener - The callback function.
5874
- * @param options - Option to support event timestamps.
5875
- *
5876
- * @function once
5877
- * @memberof Frame
5878
- * @instance
5879
- * @tutorial Frame.EventEmitter
5880
- */
5881
- /**
5882
- * Adds a listener to the beginning of the listeners array for the specified event.
5883
- * @param eventType - The type of the event.
5884
- * @param listener - The callback function.
5885
- * @param options - Option to support event timestamps.
5886
- *
5887
- * @function prependListener
5888
- * @memberof Frame
5889
- * @instance
5890
- * @tutorial Frame.EventEmitter
5891
- */
5892
- /**
5893
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5894
- * The listener is added to the beginning of the listeners array.
5895
- * @param eventType - The type of the event.
5896
- * @param listener - The callback function.
5897
- * @param options - Option to support event timestamps.
5898
- *
5899
- * @function prependOnceListener
5900
- * @memberof Frame
5901
- * @instance
5902
- * @tutorial Frame.EventEmitter
5903
- */
5904
- /**
5905
- * Remove a listener from the listener array for the specified event.
5906
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5907
- * @param eventType - The type of the event.
5908
- * @param listener - The callback function.
5909
- * @param options - Option to support event timestamps.
5910
- *
5911
- * @function removeListener
5912
- * @memberof Frame
5913
- * @instance
5914
- * @tutorial Frame.EventEmitter
5915
- */
5916
- /**
5917
- * Removes all listeners, or those of the specified event.
5918
- * @param eventType - The type of the event.
5919
- *
5920
- * @function removeAllListeners
5921
- * @memberof Frame
5922
- * @instance
5923
- * @tutorial Frame.EventEmitter
5924
- */
5925
5696
  /**
5926
5697
  * Returns a frame info object for the represented frame.
5927
5698
  *
@@ -6840,6 +6611,13 @@ declare type InitPlatformOptions = {
6840
6611
  interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
6841
6612
  };
6842
6613
 
6614
+ /**
6615
+ * * 'none': The `fin` API will be not available from within this context.
6616
+ * * 'global': The entire `fin` API will be available from within this context.
6617
+ * @defaultValue 'global'
6618
+ */
6619
+ declare type InjectionType = 'none' | 'global';
6620
+
6843
6621
  /**
6844
6622
  * Generated when the value of the element changes.
6845
6623
  * @interface
@@ -7184,56 +6962,6 @@ declare class InteropBroker extends Base {
7184
6962
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7185
6963
  new (): InteropBroker;
7186
6964
  };
7187
- /**
7188
- * @REMOVED
7189
- * SetContextOptions interface
7190
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
7191
- * @property { Context } {context} - New context to set.
7192
- */
7193
- /**
7194
- * @REMOVED
7195
- * GetContextOptions interface
7196
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
7197
- * @property { string } [contextType] - Context Type
7198
- */
7199
- /**
7200
- * @REMOVED
7201
- * JoinContextGroupOptions interface
7202
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
7203
- * @property { string } contextGroupId - Id of the context group.
7204
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
7205
- */
7206
- /**
7207
- * @REMOVED
7208
- * AddClientToContextGroupOptions interface
7209
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
7210
- * @property { string } contextGroupId - Name of the context group.
7211
- */
7212
- /**
7213
- * @REMOVED
7214
- * RemoveFromContextGroupOptions interface
7215
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
7216
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
7217
- */
7218
- /**
7219
- * @REMOVED
7220
- * GetInfoForContextGroupOptions interface
7221
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
7222
- * @property { string } contextGroupId - Name of the context group to get info for.
7223
- */
7224
- /**
7225
- * @REMOVED
7226
- * GetAllClientsInContextGroupOptions interface
7227
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
7228
- * @property { string } contextGroupId - Name of the context group to get info for.
7229
- */
7230
- /**
7231
- * @PORTED
7232
- * InfoForIntentOptions interface
7233
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
7234
- * @property { string } name Name of the intent to get info for.
7235
- * @property { Context } [context] Optional context.
7236
- */
7237
6965
  /**
7238
6966
  * Sets a context for the context group of the incoming current entity.
7239
6967
  * @param setContextOptions - New context to set.
@@ -7733,95 +7461,6 @@ declare type InteropBrokerOptions = {
7733
7461
  logging?: InteropLoggingOptions;
7734
7462
  };
7735
7463
 
7736
- /**
7737
- * @PORTED
7738
- * @typedef { object } Intent
7739
- * @summary The combination of an action and a context that is passed to an application for resolution.
7740
- * @property { string } name Name of the intent.
7741
- * @property { Context } context Data associated with the intent
7742
- */
7743
- /**
7744
- * @REMOVED
7745
- * @typedef { object } Subscription
7746
- * @summary Object returned when subscribing a handler.
7747
- * @property { function } unsubscribe Function to unsubscribe the handler.
7748
- */
7749
- /**
7750
- * @typedef { function } ContextHandler
7751
- * @summary Subscription function for addContextHandler.
7752
- */
7753
- /**
7754
- * @typedef { function } IntentHandler
7755
- * @summary Subscription function for registerIntentHandler
7756
- */
7757
- /**
7758
- * @PORTED
7759
- * @typedef { object } ClientIdentity
7760
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7761
- * @property {string} uuid GUID of an application.
7762
- * @property {string} name Name of an entity in an application.
7763
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7764
- */
7765
- /**
7766
- * @PORTED
7767
- * @typedef { object } ContextGroupInfo
7768
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7769
- * @property {string} id Name of the context group
7770
- * @property {DisplayMetadata} displayMetadata Metadata for the Context Group. Contains the group's human-readable name, color, and an image, as defined by the Interop Broker.
7771
- */
7772
- /**
7773
- * @PORTED
7774
- * @typedef { object } DisplayMetadata
7775
- * @summary The display data for a Context Group.
7776
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7777
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7778
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7779
- */
7780
- /**
7781
- * @PORTED
7782
- * @typedef { object } Context
7783
- * @summary Data passed between entities and applications.
7784
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7785
- * @property {string} [name] User-readable name for the incoming context.
7786
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7787
- */
7788
- /**
7789
- * @REMOVED
7790
- * @typedef { object } ContextForIntent
7791
- * @summary Data passed between entities and applications, including an optional metadata.
7792
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7793
- * @property {string} [name] User-readable name for the incoming context.
7794
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7795
- * @property {any} [metadata]
7796
- */
7797
- /**
7798
- * @REMOVED
7799
- * @typedef { object } SessionContextGroup
7800
- * @summary An instance of a SessionContextGroup
7801
- * @property {string} id The SessionContextGroup's id.
7802
- * @property {setContext} setContext Sets a context of a certain type
7803
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7804
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7805
- */
7806
- /**
7807
- * @typedef {function} setContext
7808
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7809
- * @param context The Context to be set.
7810
- *
7811
- */
7812
- /**
7813
- * @typedef {function} getCurrentContext
7814
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7815
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7816
- *
7817
- */
7818
- /**
7819
- * @typedef {function} addContextHandler
7820
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7821
- * @param contextHandler The callback to be invoked. Is invoked when (a) the context changes or (b) immediately after getting created if the context is already set.
7822
- * @param contextType The context type this handler should listen to. If not specified, a global handler for all context types will get created. Only one global handler is allowed per SessionContextGroup.
7823
- *
7824
- */
7825
7464
  /**
7826
7465
  * The Interop Client API is broken up into two groups:
7827
7466
  *
@@ -8255,13 +7894,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8255
7894
  */
8256
7895
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8257
7896
 
8258
- /**
8259
- * @PORTED
8260
- * @typedef { object } InteropConfig
8261
- * @summary Information relevant to the Interop Broker.
8262
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
8263
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
8264
- */
8265
7897
  /**
8266
7898
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8267
7899
  *
@@ -9239,7 +8871,7 @@ declare type LayoutOptions = {
9239
8871
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9240
8872
 
9241
8873
  /**
9242
- * @interface
8874
+ * Layout preset type.
9243
8875
  */
9244
8876
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9245
8877
 
@@ -10142,6 +9774,7 @@ declare namespace OpenFin {
10142
9774
  ResizeRegion,
10143
9775
  Accelerator,
10144
9776
  Api,
9777
+ InjectionType,
10145
9778
  NavigationRules,
10146
9779
  ContentNavigation,
10147
9780
  ContentRedirect,
@@ -10289,6 +9922,9 @@ declare namespace OpenFin {
10289
9922
  RuntimeInfo,
10290
9923
  DefaultDomainSettings,
10291
9924
  DefaultDomainSettingsRule,
9925
+ DomainSettings,
9926
+ ApiInjection,
9927
+ DomainSettingsRule,
10292
9928
  FileDownloadBehaviorNames,
10293
9929
  FileDownloadSettings,
10294
9930
  DownloadRule,
@@ -13718,83 +13354,6 @@ declare type SubscriptionOptions = {
13718
13354
  declare class System extends EmitterBase<OpenFin.SystemEvent> {
13719
13355
  /* Excluded from this release type: __constructor */
13720
13356
  private sendExternalProcessRequest;
13721
- /**
13722
- * Adds a listener to the end of the listeners array for the specified event.
13723
- * @param eventType - The type of the event.
13724
- * @param listener - Called whenever an event of the specified type occurs.
13725
- * @param options - Option to support event timestamps.
13726
- *
13727
- * @function addListener
13728
- * @memberof System
13729
- * @instance
13730
- * @tutorial System.EventEmitter
13731
- */
13732
- /**
13733
- * Adds a listener to the end of the listeners array for the specified event.
13734
- * @param eventType - The type of the event.
13735
- * @param listener - Called whenever an event of the specified type occurs.
13736
- * @param options - Option to support event timestamps.
13737
- *
13738
- * @function on
13739
- * @memberof System
13740
- * @instance
13741
- * @tutorial System.EventEmitter
13742
- */
13743
- /**
13744
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
13745
- * @param eventType - The type of the event.
13746
- * @param listener - The callback function.
13747
- * @param options - Option to support event timestamps.
13748
- *
13749
- * @function once
13750
- * @memberof System
13751
- * @instance
13752
- * @tutorial System.EventEmitter
13753
- */
13754
- /**
13755
- * Adds a listener to the beginning of the listeners array for the specified event.
13756
- * @param eventType - The type of the event.
13757
- * @param listener - The callback function.
13758
- * @param options - Option to support event timestamps.
13759
- *
13760
- * @function prependListener
13761
- * @memberof System
13762
- * @instance
13763
- * @tutorial System.EventEmitter
13764
- */
13765
- /**
13766
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
13767
- * The listener is added to the beginning of the listeners array.
13768
- * @param eventType - The type of the event.
13769
- * @param listener - The callback function.
13770
- * @param options - Option to support event timestamps.
13771
- *
13772
- * @function prependOnceListener
13773
- * @memberof System
13774
- * @instance
13775
- * @tutorial System.EventEmitter
13776
- */
13777
- /**
13778
- * Remove a listener from the listener array for the specified event.
13779
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
13780
- * @param eventType - The type of the event.
13781
- * @param listener - The callback function.
13782
- * @param options - Option to support event timestamps.
13783
- *
13784
- * @function removeListener
13785
- * @memberof System
13786
- * @instance
13787
- * @tutorial System.EventEmitter
13788
- */
13789
- /**
13790
- * Removes all listeners, or those of the specified event.
13791
- * @param eventType - The type of the event.
13792
- *
13793
- * @function removeAllListeners
13794
- * @memberof System
13795
- * @instance
13796
- * @tutorial System.EventEmitter
13797
- */
13798
13357
  /**
13799
13358
  * Returns the version of the runtime. The version contains the major, minor,
13800
13359
  * build and revision numbers.
@@ -15822,169 +15381,6 @@ declare type VerboseWebPermission = {
15822
15381
 
15823
15382
  declare type View = OpenFin.View;
15824
15383
 
15825
- /**
15826
- * @PORTED
15827
- * @typedef {object} View~options
15828
- * @summary View creation options.
15829
- * @desc This is the options object required by {@link View.create View.create}.
15830
- *
15831
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
15832
- * (defaults to `"about:blank"` when omitted).
15833
- *
15834
- * @property {object} [experimental]
15835
- * Configurations for API injection.
15836
- *
15837
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
15838
- *
15839
- * @property {object} [accelerator]
15840
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
15841
- *
15842
- * @property {boolean} [accelerator.devtools=false]
15843
- * If `true`, enables the devtools keyboard shortcut:<br>
15844
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
15845
- *
15846
- * @property {boolean} [accelerator.reload=false]
15847
- * If `true`, enables the reload keyboard shortcuts:<br>
15848
- * `Ctrl` + `R` _(Windows)_<br>
15849
- * `F5` _(Windows)_<br>
15850
- * `Command` + `R` _(Mac)_
15851
- *
15852
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
15853
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
15854
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
15855
- * `Shift` + `F5` _(Windows)_<br>
15856
- * `Command` + `Shift` + `R` _(Mac)_
15857
- *
15858
- * @property {boolean} [accelerator.zoom=false]
15859
- * If `true`, enables the zoom keyboard shortcuts:<br>
15860
- * `Ctrl` + `+` _(Zoom In)_<br>
15861
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
15862
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
15863
- * `Ctrl` + `-` _(Zoom Out)_<br>
15864
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
15865
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
15866
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
15867
- * `Ctrl` + `0` _(Restore to 100%)_
15868
- *
15869
- * @property {object} [api]
15870
- * Configurations for API injection.
15871
- *
15872
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
15873
- *
15874
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
15875
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
15876
- *
15877
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
15878
- * Autoplay policy to apply to content in the window, can be
15879
- * `no-user-gesture-required`, `user-gesture-required`,
15880
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
15881
- *
15882
- * @property {object} [autoResize] AutoResize options
15883
- *
15884
- * @property {object} [bounds] initial bounds given relative to the window.
15885
- *
15886
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
15887
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
15888
- * (`document.body.style.backgroundColor`),
15889
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
15890
- * areas when growing a window. Setting
15891
- * this value to the anticipated content background color can help improve user experience.
15892
- * Default is white.
15893
- *
15894
- * @property {object} [contentNavigation]
15895
- * Restrict navigation to URLs that match an allowed pattern.
15896
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
15897
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15898
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
15899
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
15900
- *
15901
- * @property {object} [contentRedirect]
15902
- * Restrict redirects to URLs that match an allowed pattern.
15903
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
15904
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15905
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
15906
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
15907
- *
15908
- * @property {object} [contextMenuSettings] - _Updatable._
15909
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
15910
- * Configure the context menu when right-clicking on a view.
15911
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
15912
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
15913
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
15914
- *
15915
- * @property {object} [contextMenuOptions] - _Updatable._
15916
- * Configure the context menu when right-clicking on a view. Supported menu items:
15917
- * 'separator'
15918
- * 'cut'
15919
- * 'copy'
15920
- * 'copyImage',
15921
- * 'paste'
15922
- * 'spellCheck'
15923
- * 'inspect'
15924
- * 'reload'
15925
- * 'navigateForward'
15926
- * 'navigateBack'
15927
- * 'print'
15928
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
15929
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
15930
- *
15931
- * @property {any} [customData=""] - _Updatable._
15932
- * A field that the user can attach serializable data to be ferried around with the view options.
15933
- * _When omitted, the default value of this property is the empty string (`""`)._
15934
- *
15935
- * @property {any} [customContext=""] - _Updatable._
15936
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
15937
- * is called.
15938
- * When omitted, the default value of this property is the empty string (`""`).
15939
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
15940
- *
15941
- * @property {object[]} [hotkeys=[]] - _Updatable._
15942
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
15943
- * Within Platform, OpenFin also implements a set of pre-defined actions called
15944
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
15945
- * that can be assigned to a specific hotkey in the platform manifest.
15946
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
15947
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
15948
- *
15949
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
15950
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
15951
- * if the view isn't part of the new layout when running `Layout.replace`.
15952
- *
15953
- * @property {string} name
15954
- * The name of the view.
15955
- *
15956
- * @property {boolean} [detachOnClose=false] - _Updatable._
15957
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
15958
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
15959
- *
15960
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
15961
- * but the properties in the manifest will take precedence if there is any collision.
15962
- *
15963
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
15964
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
15965
- * from the parent application.
15966
- *
15967
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
15968
- *
15969
- * @property {string} [processAffinity=<application uuid>]
15970
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
15971
- *
15972
- * @property {boolean} [spellCheck=false]
15973
- * Enable spell check in input text fields for the view.
15974
- *
15975
- * @property {Identity} [target]
15976
- * The identity of the window this view should be attached to.
15977
- *
15978
- * @property {string} [url="about:blank"]
15979
- * The URL of the view.
15980
- *
15981
- * @property {string} [uuid=<application uuid>]
15982
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
15983
- * If omitted, defaults to the `uuid` of the application spawning the view.
15984
- * If given, must match the `uuid` of the application spawning the view.
15985
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
15986
- * really no need to provide it.
15987
- */
15988
15384
  /**
15989
15385
  * A View can be used to embed additional web content into a Window.
15990
15386
  * It is like a child window, except it is positioned relative to its owning window.
@@ -17777,476 +17173,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17777
17173
  type: 'will-resize';
17778
17174
  };
17779
17175
 
17780
- /**
17781
- * @PORTED
17782
- * @typedef { object } Margins@typedef { object } Margins
17783
- * @property { string } [marginType]
17784
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
17785
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
17786
- *
17787
- * @property { number } [top] The top margin of the printed web page, in pixels.
17788
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
17789
- * @property { number } [left] The left margin of the printed web page, in pixels.
17790
- * @property { number } [right] The right margin of the printed web page, in pixels.
17791
- */
17792
- /**
17793
- * @PORTED
17794
- * @typedef { object } Dpi@typedef { object } Dpi
17795
- * @property { number } [horizontal] The horizontal dpi
17796
- * @property { number } [vertical] The vertical dpi
17797
- */
17798
- /**
17799
- * @PORTED
17800
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
17801
- * @property { boolean } [silent=false] Don't ask user for print settings.
17802
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
17803
- * @property { string } [deviceName=''] Set the printer device name to use.
17804
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
17805
- * @property { Margins } [margins] Set margins for the printed web page
17806
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
17807
- * @property { number } [scaleFactor] The scale factor of the web page.
17808
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
17809
- * @property { boolean } [collate] Whether the web page should be collated.
17810
- * @property { number } [copies] The number of copies of the web page to print.
17811
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
17812
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
17813
- * @property { Dpi } [dpi] Set dpi for the printed web page
17814
- */
17815
- /**
17816
- * @REMOVED
17817
- * PrinterInfo interface
17818
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
17819
- * @property { string } name Printer Name
17820
- * @property { string } description Printer Description
17821
- * @property { number } status Printer Status
17822
- * @property { boolean } isDefault Indicates that system's default printer
17823
- */
17824
- /**
17825
- * @REMOVED
17826
- * SharedWorkerInfo interface
17827
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
17828
- * @property { string } id The unique id of the shared worker.
17829
- * @property { string } url The url of the shared worker.
17830
- */
17831
- /**
17832
- * @PORTED
17833
- * ContentCreationRule interface
17834
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
17835
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
17836
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
17837
- * @property { object } options Window creation options or View creation options.
17838
- */
17839
- /**
17840
- * @PORTED
17841
- * @typedef {object} Window~options
17842
- * @summary Window creation options.
17843
- * @desc This is the options object required by {@link Window.create Window.create}.
17844
- *
17845
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
17846
- * (defaults to `"about:blank"` when omitted).
17847
- *
17848
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
17849
- *
17850
- * @property {object} [accelerator]
17851
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
17852
- *
17853
- * @property {boolean} [accelerator.devtools=false]
17854
- * If `true`, enables the devtools keyboard shortcut:<br>
17855
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
17856
- *
17857
- * @property {boolean} [accelerator.reload=false]
17858
- * If `true`, enables the reload keyboard shortcuts:<br>
17859
- * `Ctrl` + `R` _(Windows)_<br>
17860
- * `F5` _(Windows)_<br>
17861
- * `Command` + `R` _(Mac)_
17862
- *
17863
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
17864
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
17865
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
17866
- * `Shift` + `F5` _(Windows)_<br>
17867
- * `Command` + `Shift` + `R` _(Mac)_
17868
- *
17869
- * @property {boolean} [accelerator.zoom=false]
17870
- * NOTE: It is not recommended to set this value to true for Windows in Platforms as that may lead to unexpected visual shifts in layout.
17871
- * If `true`, enables the zoom keyboard shortcuts:<br>
17872
- * `Ctrl` + `+` _(Zoom In)_<br>
17873
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
17874
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
17875
- * `Ctrl` + `-` _(Zoom Out)_<br>
17876
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
17877
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
17878
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
17879
- * `Ctrl` + `0` _(Restore to 100%)_
17880
- *
17881
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
17882
- * <br>
17883
- * alphaMask turns anything of matching RGB value transparent.
17884
- * <br>
17885
- * Caveats:
17886
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
17887
- * * User cannot click-through transparent regions
17888
- * * Not supported on Mac
17889
- * * Windows Aero must be enabled
17890
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
17891
- * * Not supported on rounded corner windows
17892
- * @property {number} [alphaMask.red=-1] 0-255
17893
- * @property {number} [alphaMask.green=-1] 0-255
17894
- * @property {number} [alphaMask.blue=-1] 0-255
17895
- *
17896
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
17897
- * A flag to always position the window at the top of the window stack.
17898
- *
17899
- * @property {object} [api]
17900
- * Configurations for API injection.
17901
- *
17902
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
17903
- *
17904
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
17905
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
17906
- *
17907
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
17908
- *
17909
- * @property {number} [aspectRatio=0] - _Updatable._
17910
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
17911
- * an aspect ratio will not be enforced.
17912
- *
17913
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
17914
- * Autoplay policy to apply to content in the window, can be
17915
- * `no-user-gesture-required`, `user-gesture-required`,
17916
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
17917
- *
17918
- * @property {boolean} [autoShow=true]
17919
- * A flag to automatically show the window when it is created.
17920
- *
17921
- * @property {string} [backgroundColor="#FFF"]
17922
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
17923
- * (`document.body.style.backgroundColor`),
17924
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
17925
- * areas when growing a window. Setting
17926
- * this value to the anticipated content background color can help improve user experience.
17927
- * Default is white.
17928
- *
17929
- * @property {object} [contentCreation]
17930
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
17931
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
17932
- *
17933
- * @property {object} [contentNavigation]
17934
- * Restrict navigation to URLs that match an allowed pattern.
17935
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
17936
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17937
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
17938
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
17939
- *
17940
- * @property {object} [contentRedirect]
17941
- * Restrict redirects to URLs that match an allowed pattern.
17942
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
17943
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17944
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
17945
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
17946
- *
17947
- * @property {boolean} [contextMenu=true] - _Updatable._
17948
- * A flag to show the context menu when right-clicking on a window.
17949
- * Gives access to the devtools for the window.
17950
- *
17951
- * @property {object} [contextMenuSettings] - _Updatable._
17952
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
17953
- * Configure the context menu when right-clicking on a window.
17954
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
17955
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
17956
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
17957
- *
17958
- * @property {object} [contextMenuOptions] - _Updatable._
17959
- * Configure the context menu when right-clicking on a window. Supported menu items:
17960
- * 'separator'
17961
- * 'cut'
17962
- * 'copy'
17963
- * 'paste'
17964
- * 'spellCheck'
17965
- * 'inspect'
17966
- * 'reload'
17967
- * 'navigateForward'
17968
- * 'navigateBack'
17969
- * 'print'
17970
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
17971
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
17972
- *
17973
- * @property {object} [cornerRounding] - _Updatable._
17974
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
17975
- * average of _height_ and _width_.
17976
- * @property {number} [cornerRounding.height=0] The height in pixels.
17977
- * @property {number} [cornerRounding.width=0] The width in pixels.
17978
- *
17979
- * @property {any} [customContext=""] - _Updatable. Inheritable._
17980
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
17981
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
17982
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
17983
- * _When omitted, _inherits_ from the parent application._
17984
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
17985
- *
17986
- * @property {any} [customData=""] - _Updatable. Inheritable._
17987
- * A field that the user can attach serializable data to be ferried around with the window options.
17988
- * _When omitted, _inherits_ from the parent application._
17989
- *
17990
- * @property {object[]} [customRequestHeaders]
17991
- * Defines list of custom headers for requests sent by the window.
17992
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
17993
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
17994
- * where the object key is the name of header and value at key is the value of the header
17995
- *
17996
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
17997
- * Toggling off would keep the Window alive even if all its Views were closed.
17998
- * This is meant for advanced users and should be used with caution.
17999
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
18000
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
18001
- * ** note ** - This option is ignored in non-Platforms apps.
18002
- *
18003
- * @property {boolean} [defaultCentered=false]
18004
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
18005
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
18006
- * somewhat above center vertically.
18007
- *
18008
- * @property {number} [defaultHeight=500]
18009
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
18010
- * in favor of the cached value.
18011
- *
18012
- * @property {number} [defaultLeft=100]
18013
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18014
- * launches in favor of the cached value.
18015
- *
18016
- * @property {number} [defaultTop=100]
18017
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18018
- * launches in favor of the cached value.
18019
- *
18020
- * @property {number} [defaultWidth=800]
18021
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18022
- * launches in favor of the cached value.
18023
- *
18024
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
18025
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
18026
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
18027
- *
18028
- * @property {boolean} [frame=true] - _Updatable._
18029
- * A flag to show the frame.
18030
- *
18031
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
18032
- *
18033
- * @property {object[]} [hotkeys=[]] - _Updatable._
18034
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
18035
- * Within Platform, OpenFin also implements a set of pre-defined actions called
18036
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
18037
- * that can be assigned to a specific hotkey in the platform manifest.
18038
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
18039
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
18040
- *
18041
- * @property {string} [icon] - _Updatable. Inheritable._
18042
- * A URL for the icon to be shown in the window title bar and the taskbar.
18043
- * When omitted, inherits from the parent application._
18044
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
18045
- *
18046
- * @property {number} [maxHeight=-1] - _Updatable._
18047
- * The maximum height of a window. Will default to the OS defined value if set to -1.
18048
- *
18049
- * @property {boolean} [maximizable=true] - _Updatable._
18050
- * A flag that lets the window be maximized.
18051
- *
18052
- * @property {number} [maxWidth=-1] - _Updatable._
18053
- * The maximum width of a window. Will default to the OS defined value if set to -1.
18054
- *
18055
- * @property {number} [minHeight=0] - _Updatable._
18056
- * The minimum height of a window.
18057
- *
18058
- * @property {boolean} [minimizable=true] - _Updatable._
18059
- * A flag that lets the window be minimized.
18060
- *
18061
- * @property {number} [minWidth=0] - _Updatable._
18062
- * The minimum width of a window.
18063
- *
18064
- * @property {Identity} [modalParentIdentity]
18065
- * Parent identity of a modal window. It will create a modal child window when this option is set.
18066
- *
18067
- * @property {string} name
18068
- * The name of the window.
18069
- *
18070
- * @property {number} [opacity=1.0] - _Updatable._
18071
- * A flag that specifies how transparent the window will be.
18072
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
18073
- * This value is clamped between `0.0` and `1.0`.
18074
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
18075
- *
18076
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
18077
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
18078
- * from the parent application.
18079
- *
18080
- * @property {string} [processAffinity]
18081
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
18082
- *
18083
- * @property {boolean} [resizable=true] - _Updatable._
18084
- * A flag to allow the user to resize the window.
18085
- *
18086
- * @property {object} [resizeRegion] - _Updatable._
18087
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
18088
- * @property {number} [resizeRegion.bottomRightCorner=9]
18089
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
18090
- * @property {number} [resizeRegion.size=7]
18091
- * The size in pixels.
18092
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
18093
- * Sides that a window can be resized from.
18094
- *
18095
- * @property {boolean} [saveWindowState=true]
18096
- * A flag to cache the location of the window.
18097
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
18098
- *
18099
- * @property {boolean} [ignoreSavedWindowState]
18100
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
18101
- *
18102
- * @property {boolean} [shadow=false]
18103
- * A flag to display a shadow on frameless windows.
18104
- * `shadow` and `cornerRounding` are mutually exclusive.
18105
- * On Windows 7, Aero theme is required.
18106
- *
18107
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
18108
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
18109
- * This occurs when the window is resizing or a tab is being dragged within the layout.
18110
- *
18111
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
18112
- * A flag to show the window's icon in the taskbar.
18113
- *
18114
- * @property {boolean} [smallWindow=false]
18115
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
18116
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
18117
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
18118
- *
18119
- * @property {boolean} [spellCheck=false]
18120
- * Enable spell check in input text fields for the window.
18121
- *
18122
- * @property {string} [state="normal"]
18123
- * The visible state of the window on creation.
18124
- * One of:
18125
- * * `"maximized"`
18126
- * * `"minimized"`
18127
- * * `"normal"`
18128
- *
18129
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
18130
- *
18131
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
18132
- * Specify a taskbar group for the window.
18133
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
18134
- *
18135
- * @property {string} [url="about:blank"]
18136
- * The URL of the window.
18137
- *
18138
- * @property {string} [uuid=<application uuid>]
18139
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
18140
- * If omitted, defaults to the `uuid` of the application spawning the window.
18141
- * If given, must match the `uuid` of the application spawning the window.
18142
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
18143
- * really no need to provide it.
18144
- *
18145
- * @property {boolean} [waitForPageLoad=false]
18146
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
18147
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
18148
- *
18149
- * @property {ViewVisibility} [viewVisibility]
18150
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18151
- */
18152
- /**
18153
- * @PORTED
18154
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18155
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
18156
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18157
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
18158
- */
18159
- /**
18160
- * @PORTED
18161
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
18162
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
18163
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
18164
- */
18165
- /**
18166
- * @REMOVED
18167
- * @typedef {Object} ShowViewsOnSplitterDrag@typedef {Object} ShowViewsOnSplitterDrag _Platform Windows Only_. Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18168
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
18169
- */
18170
- /**
18171
- * @REMOVED
18172
- * @typedef {Object} ShowViewsOnTabDrag@typedef {Object} ShowViewsOnTabDrag _Platform Windows Only_. Allows views to be shown when the user is manipulating the layout by repositioning a tab.
18173
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
18174
- */
18175
- /**
18176
- * @PORTED
18177
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
18178
- * @property { Area } [area] The area of the window to be captured.
18179
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
18180
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
18181
- */
18182
- /**
18183
- * @PORTED
18184
- * @typedef { object } Area@typedef { object } Area
18185
- * @property { number } height Area's height
18186
- * @property { number } width Area's width
18187
- * @property { number } x X coordinate of area's starting point
18188
- * @property { number } y Y coordinate of area's starting point
18189
- */
18190
- /**
18191
- * @PORTED
18192
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
18193
- * @property {boolean} [forward=true] Whether to search forward or backward.
18194
- * @property {boolean} [findNext=false] Whether to begin a new text finding session. Should be true for first requests, and false for subsequent requests. Defaults to false.
18195
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
18196
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
18197
- * @property {boolean} [medialCapitalAsWordStart=false]
18198
- * When combined with wordStart, accepts a match in the middle of a word if the match begins with an uppercase letter followed by a<br>
18199
- * lowercase or non-letter. Accepts several other intra-word matches.
18200
- */
18201
- /**
18202
- * @REMOVED
18203
- * @typedef {object} Transition@typedef {object} Transition
18204
- * @property {Opacity} opacity - The Opacity transition
18205
- * @property {Position} position - The Position transition
18206
- * @property {Size} size - The Size transition
18207
- */
18208
- /**
18209
- * @PORTED
18210
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
18211
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
18212
- this animation onto the end of the animation queue.
18213
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18214
- */
18215
- /**
18216
- * @PORTED
18217
- * @typedef {object} Size@typedef {object} Size
18218
- * @property {number} duration - The total time in milliseconds this transition should take.
18219
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18220
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
18221
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
18222
- */
18223
- /**
18224
- * @PORTED
18225
- * @typedef {object} Position@typedef {object} Position
18226
- * @property {number} duration - The total time in milliseconds this transition should take.
18227
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18228
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
18229
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
18230
- */
18231
- /**
18232
- * @PORTED
18233
- * @typedef {object} Opacity@typedef {object} Opacity
18234
- * @property {number} duration - The total time in milliseconds this transition should take.
18235
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18236
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
18237
- */
18238
- /**
18239
- * @REMOVED
18240
- * Bounds is a interface that has the properties of height,
18241
- * width, left, top which are all numbers
18242
- * @typedef { object } Bounds@typedef { object } Bounds
18243
- * @property { number } height Get the application height bound
18244
- * @property { number } width Get the application width bound
18245
- * @property { number } top Get the application top bound
18246
- * @property { number } left Get the application left bound
18247
- * @property { number } right Get the application right bound
18248
- * @property { number } bottom Get the application bottom bound
18249
- */
18250
17176
  /**
18251
17177
  * A basic window that wraps a native HTML window. Provides more fine-grained
18252
17178
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -19096,28 +18022,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19096
18022
  * ```
19097
18023
  */
19098
18024
  authenticate(userName: string, password: string): Promise<void>;
19099
- /**
19100
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
19101
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
19102
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
19103
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
19104
- */
19105
- /**
19106
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
19107
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
19108
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
19109
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
19110
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
19111
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
19112
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
19113
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
19114
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
19115
- */
19116
- /**
19117
- * @typedef {object} MenuResult@typedef {object} MenuResult
19118
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
19119
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
19120
- */
19121
18025
  /**
19122
18026
  * Shows a menu on the window.
19123
18027
  *
@@ -19214,577 +18118,552 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19214
18118
  */
19215
18119
  closePopupMenu(): Promise<void>;
19216
18120
  /**
19217
- * @PORTED
19218
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19219
- * @property {string} [name] - If a window with this `name` exists, it will be shown as a popup. Otherwise, a new window with this `name` will be created. If this `name` is undefined, `initialOptions.name` will be used. If this `name` and `intialOptions.name` are both undefined, a `name` will be generated.
19220
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19221
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19222
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19223
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19224
- * @property {function} [onPopupReady] - Executed when the popup window is shown. Provides the popup window to the provided function, and allows for easy access the popup window for additional behavior customization.
19225
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19226
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19227
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19228
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19229
- * @property {'modal' | 'hide' | 'close'} [blurBehavior] - Determines what happens if the popup window is blurred. 'modal' restricts resizing and positioning in the caller, 'hide' hides the popup window on blur and 'close' closes the popup window on blur.
19230
- * @property {'none' | 'hide' | 'close'} [resultDispatchBehavior] - Determines what happens when the popup window calls `dispatchPopupResult`. 'none' will do nothing, 'hide' hides the popup window on `dispatchPopupResult` and 'close' closes the popup window on `dispatchPopupResult`.
19231
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19232
- * @property {boolean} [hideOnClose] - Hide the popup window instead of closing whenever `close` is called on it. Note: if this is `true` and `blurBehavior` and/or `resultDispatchBehavior` are set to `close`, the window will be hidden.
19233
- */
19234
- /**
19235
- * @PORTED
19236
- * @typedef {object} PopupResult@typedef {object} PopupResult
19237
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19238
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19239
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19240
- */
19241
- /**
19242
- * Dispatch a result to the caller of `showPopupWindow`.
19243
- *
19244
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19245
- * @param data Serializable data to send to the caller window.
19246
- *
19247
- * @example
19248
- * ```js
19249
- * await fin.me.dispatchPopupResult({
19250
- * foo: 'bar'
19251
- * });
19252
- * ```
19253
- */
19254
- dispatchPopupResult(data: any): Promise<void>;
19255
- /**
19256
- * Prints the contents of the window.
19257
- *
19258
- * @param options Configuration for the print task.
19259
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19260
- * and the default settings for printing.
19261
- *
19262
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19263
- *
19264
- * @example
19265
- * ```js
19266
- * const win = fin.Window.getCurrentSync();
19267
- *
19268
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19269
- * console.log('print call has been sent to the system');
19270
- * });
19271
- * ```
19272
- *
19273
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19274
- * use the `content` option:
19275
- *
19276
- * ```js
19277
- * const win = fin.Window.getCurrentSync();
19278
- *
19279
- * // Print embedded views
19280
- * win.print({ content: 'views' });
19281
- *
19282
- * // Print screenshot of current window
19283
- * win.print({ content: 'screenshot' })
19284
- * ```
19285
- *
19286
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19287
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19288
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19289
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19290
- *
19291
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19292
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19293
- *
19294
- * To print the views embedded in their page context, set `content` to `screenshot`.
19295
- */
19296
- print(options?: OpenFin.WindowPrintOptions): Promise<void>;
19297
- }
19298
-
19299
- /**
19300
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19301
- * @interface
19302
- */
19303
- declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19304
- type: 'window-alert-requested';
19305
- };
19306
-
19307
- /**
19308
- * Returned from getBounds call. bottom and right are never used for setting.
19309
- * @interface
19310
- */
19311
- declare type WindowBounds = Bounds & {
19312
- bottom: number;
19313
- right: number;
19314
- };
19315
-
19316
- /**
19317
- * @deprecated Renamed to {@link ClosedEvent}.
19318
- */
19319
- declare type WindowClosedEvent = ClosedEvent_2;
19320
-
19321
- /**
19322
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19323
- */
19324
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19325
-
19326
- /**
19327
- * @deprecated Renamed to {@link ClosingEvent}.
19328
- */
19329
- declare type WindowClosingEvent = ClosingEvent;
19330
-
19331
- /**
19332
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19333
- *
19334
- * @interface
19335
- */
19336
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19337
- /**
19338
- * Behavior to use when opening matched content.
19339
- */
19340
- behavior: 'window';
19341
- /**
19342
- * Options for newly-created window.
19343
- */
19344
- options?: Partial<WindowOptions>;
19345
- };
19346
-
19347
- /**
19348
- * Generated when a child window is created.
19349
- * @interface
19350
- */
19351
- declare type WindowCreatedEvent = BaseEvent_3 & {
19352
- type: 'window-created';
19353
- };
19354
-
19355
- /**
19356
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19357
- *
19358
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19359
- * (defaults to `"about:blank"` when omitted).
19360
- * @interface
19361
- */
19362
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19363
- name: string;
19364
- };
19365
-
19366
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19367
-
19368
- /**
19369
- * @interface
19370
- */
19371
- declare type WindowDetail = {
19372
- /**
19373
- * The bottom-most coordinate of the window.
19374
- */
19375
- bottom: number;
19376
- /**
19377
- * The height of the window.
19378
- */
19379
- height: number;
19380
- isShowing: boolean;
19381
- /**
19382
- * The left-most coordinate of the window.
19383
- */
19384
- left: number;
19385
- /**
19386
- * The name of the window.
19387
- */
19388
- name: string;
19389
- /**
19390
- * The right-most coordinate of the window.
19391
- */
19392
- right: number;
19393
- state: string;
19394
- /**
19395
- * The top-most coordinate of the window.
19396
- */
19397
- top: number;
19398
- /**
19399
- * The width of the window.
19400
- */
19401
- width: number;
19402
- };
19403
-
19404
- /**
19405
- * Generated when a child window ends loading.
19406
- * @interface
19407
- */
19408
- declare type WindowEndLoadEvent = BaseEvent_3 & {
19409
- type: 'window-end-load';
19410
- };
19411
-
19412
- /**
19413
- * @deprecated, Renamed to {@link Event}.
19414
- */
19415
- declare type WindowEvent = Event_6;
19416
-
19417
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19418
-
19419
- declare namespace WindowEvents {
19420
- export {
19421
- BaseEvent_5 as BaseEvent,
19422
- BaseWindowEvent,
19423
- ViewAttachedEvent,
19424
- ViewDetachedEvent,
19425
- WindowViewEvent,
19426
- AlertRequestedEvent,
19427
- AuthRequestedEvent,
19428
- EndLoadEvent,
19429
- WillRedirectEvent,
19430
- ReloadedEvent,
19431
- OptionsChangedEvent,
19432
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19433
- ExternalProcessExitedEvent,
19434
- ExternalProcessStartedEvent,
19435
- HiddenEvent_2 as HiddenEvent,
19436
- WindowHiddenEvent,
19437
- PreloadScriptInfoRunning,
19438
- PreloadScriptInfo,
19439
- PreloadScriptsStateChangeEvent,
19440
- UserBoundsChangeEvent,
19441
- BoundsChangeEvent,
19442
- WillMoveOrResizeEvent,
19443
- PerformanceReportEvent,
19444
- InputEvent_2 as InputEvent,
19445
- LayoutInitializedEvent,
19446
- LayoutReadyEvent,
19447
- BeginUserBoundsChangingEvent,
19448
- BoundsChangedEvent,
19449
- BoundsChangingEvent,
19450
- CloseRequestedEvent,
19451
- WindowCloseRequestedEvent,
19452
- ContextChangedEvent,
19453
- ClosedEvent_2 as ClosedEvent,
19454
- WindowClosedEvent,
19455
- ClosingEvent,
19456
- WindowClosingEvent,
19457
- DisabledMovementBoundsChangedEvent,
19458
- DisabledMovementBoundsChangingEvent,
19459
- EmbeddedEvent,
19460
- EndUserBoundsChangingEvent,
19461
- HotkeyEvent_2 as HotkeyEvent,
19462
- WindowHotkeyEvent,
19463
- InitializedEvent_2 as InitializedEvent,
19464
- WindowInitializedEvent,
19465
- MaximizedEvent,
19466
- MinimizedEvent,
19467
- PreloadScriptsStateChangedEvent,
19468
- PreloadScriptsStateChangingEvent,
19469
- RestoredEvent,
19470
- WindowRestoredEvent,
19471
- ShowRequestedEvent,
19472
- WindowShowRequestedEvent,
19473
- ShownEvent_2 as ShownEvent,
19474
- WindowShownEvent,
19475
- UserMovementEnabledEvent,
19476
- UserMovementDisabledEvent,
19477
- WillMoveEvent,
19478
- WillResizeEvent,
19479
- NonPropagatedWindowEvent,
19480
- ShowAllDownloadsEvent,
19481
- DownloadShelfVisibilityChangedEvent,
19482
- WindowSourcedEvent,
19483
- WillPropagateWindowEvent,
19484
- Event_6 as Event,
19485
- WindowEvent,
19486
- EventType_2 as EventType,
19487
- WindowEventType,
19488
- PropagatedEvent_3 as PropagatedEvent,
19489
- PropagatedWindowEvent,
19490
- PropagatedWindowEventType,
19491
- Payload_3 as Payload,
19492
- ByType_2 as ByType
19493
- }
19494
- }
19495
-
19496
- /**
19497
- * @deprecated Renamed to {@link EventType}.
19498
- */
19499
- declare type WindowEventType = WindowEvent['type'];
19500
-
19501
- /**
19502
- * @deprecated Renamed to {@link HiddenEvent}.
19503
- */
19504
- declare type WindowHiddenEvent = HiddenEvent_2;
19505
-
19506
- /**
19507
- * @deprecated Renamed to {@link HotkeyEvent}.
19508
- */
19509
- declare type WindowHotkeyEvent = HotkeyEvent_2;
19510
-
19511
- /**
19512
- * @interface
19513
- */
19514
- declare type WindowInfo = {
19515
- canNavigateBack: boolean;
19516
- canNavigateForward: boolean;
19517
- preloadScripts: Array<any>;
19518
- title: string;
19519
- url: string;
19520
- };
19521
-
19522
- /**
19523
- * @deprecated Renamed to {@link InitializedEvent}.
19524
- */
19525
- declare type WindowInitializedEvent = InitializedEvent_2;
19526
-
19527
- /**
19528
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
19529
- */
19530
- declare class _WindowModule extends Base {
19531
- /**
19532
- * Asynchronously returns a Window object that represents an existing window.
19533
- *
19534
- * @example
19535
- * ```js
19536
- * async function createWin() {
19537
- * const app = await fin.Application.start({
19538
- * name: 'myApp',
19539
- * uuid: 'app-1',
19540
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
19541
- * autoShow: true
19542
- * });
19543
- * return await app.getWindow();
19544
- * }
19545
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
19546
- * .then(win => console.log('wrapped window'))
19547
- * .catch(err => console.log(err));
19548
- * ```
19549
- */
19550
- wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
19551
- /**
19552
- * Synchronously returns a Window object that represents an existing window.
19553
- *
19554
- * @example
19555
- * ```js
19556
- * async function createWin() {
19557
- * const app = await fin.Application.start({
19558
- * name: 'myApp',
19559
- * uuid: 'app-1',
19560
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
19561
- * autoShow: true
19562
- * });
19563
- * return await app.getWindow();
19564
- * }
19565
- * await createWin();
19566
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
19567
- * ```
19568
- */
19569
- wrapSync(identity: OpenFin.Identity): OpenFin.Window;
19570
- /**
19571
- * Creates a new Window.
19572
- * @param options - Window creation options
19573
- *
19574
- * @example
19575
- * ```js
19576
- * async function createWindow() {
19577
- * const winOption = {
19578
- * name:'child',
19579
- * defaultWidth: 300,
19580
- * defaultHeight: 300,
19581
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
19582
- * frame: true,
19583
- * autoShow: true
19584
- * };
19585
- * return await fin.Window.create(winOption);
19586
- * }
19587
- *
19588
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
19589
- * ```
19590
- */
19591
- create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
19592
- /**
19593
- * Asynchronously returns a Window object that represents the current window
19594
- *
19595
- * @example
19596
- * ```js
19597
- * fin.Window.getCurrent()
19598
- * .then(wnd => console.log('current window'))
19599
- * .catch(err => console.log(err));
19600
- *
19601
- * ```
19602
- */
19603
- getCurrent(): Promise<OpenFin.Window>;
19604
- /**
19605
- * Synchronously returns a Window object that represents the current window
19606
- *
19607
- * @example
19608
- * ```js
19609
- * const wnd = fin.Window.getCurrentSync();
19610
- * const info = await wnd.getInfo();
19611
- * console.log(info);
19612
- *
19613
- * ```
19614
- */
19615
- getCurrentSync(): OpenFin.Window;
19616
- }
19617
-
19618
- /**
19619
- * Generated when a child window is not responding.
19620
- * @interface
19621
- */
19622
- declare type WindowNotRespondingEvent = BaseEvent_3 & {
19623
- type: 'window-not-responding';
19624
- };
19625
-
19626
- /**
19627
- * @interface
19628
- */
19629
- declare type WindowOptionDiff = {
19630
- [key in keyof WindowOptions]: {
19631
- oldVal: WindowOptions[key];
19632
- newVal: WindowOptions[key];
19633
- };
19634
- };
19635
-
19636
- /**
19637
- * @interface
19638
- */
19639
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
19640
-
19641
- declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
19642
-
19643
- /**
19644
- * @deprecated Renamed to {@link OptionsChangedEvent}.
19645
- */
19646
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19647
-
19648
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19649
-
19650
- /**
19651
- * Generated when a child window is responding.
19652
- * @interface
19653
- */
19654
- declare type WindowRespondingEvent = BaseEvent_3 & {
19655
- type: 'window-responding';
19656
- };
19657
-
19658
- /**
19659
- * @deprecated Renamed to {@link RestoredEvent}.
19660
- */
19661
- declare type WindowRestoredEvent = RestoredEvent;
19662
-
19663
- /**
19664
- * @deprecated Renamed to {@link ShownEvent}.
19665
- */
19666
- declare type WindowShownEvent = ShownEvent_2;
19667
-
19668
- /**
19669
- * @deprecated Renamed to {@link ShowRequestedEvent}.
19670
- */
19671
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
19672
-
19673
- /**
19674
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19675
- * from {@link OpenFin.ViewEvents}.
19676
- */
19677
- 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 | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
19678
-
19679
- /**
19680
- * Generated when a child window starts loading.
19681
- * @interface
19682
- */
19683
- declare type WindowStartLoadEvent = BaseEvent_3 & {
19684
- type: 'window-start-load';
19685
- };
19686
-
19687
- /**
19688
- * Visibility state of a window.
19689
- */
19690
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
19691
-
19692
- /**
19693
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19694
- * to the `Application` level, with the name pattern `window-view-eventname`.
19695
- */
19696
- declare type WindowViewEvent = {
19697
- viewIdentity: OpenFin.Identity;
19698
- } & (ViewAttachedEvent | ViewDetachedEvent);
19699
-
19700
- /**
19701
- * @interface
19702
- */
19703
- declare type WindowViewsPrintOptions = {
19704
- content: 'views';
19705
- includeSelf?: boolean;
19706
- };
19707
-
19708
- declare type Wire = EventEmitter & {
19709
- connect(messageReciever: MessageReceiver): Promise<any>;
19710
- connectSync(): any;
19711
- send(data: any): Promise<any>;
19712
- shutdown(): Promise<void>;
19713
- getPort(): string;
19714
- };
19715
-
19716
- declare type WireConstructor = {
19717
- new (onmessage: (data: any) => void): Wire;
19718
- };
19719
-
19720
- /* Excluded from this release type: WithId */
19721
-
19722
- declare interface WithInterop {
19723
- interop: InteropClient;
19724
- }
19725
-
19726
- /* Excluded from this release type: WithoutId */
19727
-
19728
- declare type WithPositioningOptions<T extends {} = {}> = T & {
19729
- positioningOptions?: OpenFin.PositioningOptions;
19730
- };
19731
-
19732
- /* Excluded from this release type: WorkspacePlatformOptions */
19733
-
19734
- /**
19735
- * A generic request to write any supported data to the clipboard.
19736
- * @interface
19737
- */
19738
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19739
- /**
19740
- * Data to be written
19741
- */
19742
- data: {
19743
- text?: string;
19744
- html?: string;
19745
- rtf?: string;
19746
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19747
- };
19748
-
19749
- /**
19750
- * @deprecated - instead use WriteAnyClipboardRequest
19751
- *
19752
- * A generic request to write any supported data to the clipboard.
19753
- *
19754
- * @interface
19755
- */
19756
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19757
-
19758
- /**
19759
- * A request to write data to the clipboard.
19760
- * @interface
19761
- */
19762
- declare type WriteClipboardRequest = BaseClipboardRequest & {
19763
- /**
19764
- * Data to write to the clipboard.
19765
- */
19766
- data: string;
19767
- };
19768
-
19769
- /**
19770
- * @interface
19771
- */
19772
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19773
- /**
19774
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
19775
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19776
- * Using other image/<format> DataURLs will throw an Error.
19777
- */
19778
- image: string;
19779
- };
19780
-
19781
- /**
19782
- * @deprecated - instead use OpenFin.WriteClipboardRequest
19783
- *
19784
- * A request to write data to the clipboard.
19785
- *
19786
- * @interface
19787
- */
19788
- declare type WriteRequestType = WriteClipboardRequest;
19789
-
19790
- export { }
18121
+ * Dispatch a result to the caller of `showPopupWindow`.
18122
+ *
18123
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18124
+ * @param data Serializable data to send to the caller window.
18125
+ *
18126
+ * @example
18127
+ * ```js
18128
+ * await fin.me.dispatchPopupResult({
18129
+ * foo: 'bar'
18130
+ * });
18131
+ * ```
18132
+ */
18133
+ dispatchPopupResult(data: any): Promise<void>;
18134
+ /**
18135
+ * Prints the contents of the window.
18136
+ *
18137
+ * @param options Configuration for the print task.
18138
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18139
+ * and the default settings for printing.
18140
+ *
18141
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18142
+ *
18143
+ * @example
18144
+ * ```js
18145
+ * const win = fin.Window.getCurrentSync();
18146
+ *
18147
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18148
+ * console.log('print call has been sent to the system');
18149
+ * });
18150
+ * ```
18151
+ *
18152
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18153
+ * use the `content` option:
18154
+ *
18155
+ * ```js
18156
+ * const win = fin.Window.getCurrentSync();
18157
+ *
18158
+ * // Print embedded views
18159
+ * win.print({ content: 'views' });
18160
+ *
18161
+ * // Print screenshot of current window
18162
+ * win.print({ content: 'screenshot' })
18163
+ * ```
18164
+ *
18165
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18166
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18167
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18168
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18169
+ *
18170
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18171
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18172
+ *
18173
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18174
+ */
18175
+ print(options?: OpenFin.WindowPrintOptions): Promise<void>;
18176
+ }
18177
+
18178
+ /**
18179
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18180
+ * @interface
18181
+ */
18182
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18183
+ type: 'window-alert-requested';
18184
+ };
18185
+
18186
+ /**
18187
+ * Returned from getBounds call. bottom and right are never used for setting.
18188
+ * @interface
18189
+ */
18190
+ declare type WindowBounds = Bounds & {
18191
+ bottom: number;
18192
+ right: number;
18193
+ };
18194
+
18195
+ /**
18196
+ * @deprecated Renamed to {@link ClosedEvent}.
18197
+ */
18198
+ declare type WindowClosedEvent = ClosedEvent_2;
18199
+
18200
+ /**
18201
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18202
+ */
18203
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18204
+
18205
+ /**
18206
+ * @deprecated Renamed to {@link ClosingEvent}.
18207
+ */
18208
+ declare type WindowClosingEvent = ClosingEvent;
18209
+
18210
+ /**
18211
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18212
+ *
18213
+ * @interface
18214
+ */
18215
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18216
+ /**
18217
+ * Behavior to use when opening matched content.
18218
+ */
18219
+ behavior: 'window';
18220
+ /**
18221
+ * Options for newly-created window.
18222
+ */
18223
+ options?: Partial<WindowOptions>;
18224
+ };
18225
+
18226
+ /**
18227
+ * Generated when a child window is created.
18228
+ * @interface
18229
+ */
18230
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18231
+ type: 'window-created';
18232
+ };
18233
+
18234
+ /**
18235
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18236
+ *
18237
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18238
+ * (defaults to `"about:blank"` when omitted).
18239
+ * @interface
18240
+ */
18241
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18242
+ name: string;
18243
+ };
18244
+
18245
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18246
+
18247
+ /**
18248
+ * @interface
18249
+ */
18250
+ declare type WindowDetail = {
18251
+ /**
18252
+ * The bottom-most coordinate of the window.
18253
+ */
18254
+ bottom: number;
18255
+ /**
18256
+ * The height of the window.
18257
+ */
18258
+ height: number;
18259
+ isShowing: boolean;
18260
+ /**
18261
+ * The left-most coordinate of the window.
18262
+ */
18263
+ left: number;
18264
+ /**
18265
+ * The name of the window.
18266
+ */
18267
+ name: string;
18268
+ /**
18269
+ * The right-most coordinate of the window.
18270
+ */
18271
+ right: number;
18272
+ state: string;
18273
+ /**
18274
+ * The top-most coordinate of the window.
18275
+ */
18276
+ top: number;
18277
+ /**
18278
+ * The width of the window.
18279
+ */
18280
+ width: number;
18281
+ };
18282
+
18283
+ /**
18284
+ * Generated when a child window ends loading.
18285
+ * @interface
18286
+ */
18287
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18288
+ type: 'window-end-load';
18289
+ };
18290
+
18291
+ /**
18292
+ * @deprecated, Renamed to {@link Event}.
18293
+ */
18294
+ declare type WindowEvent = Event_6;
18295
+
18296
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18297
+
18298
+ declare namespace WindowEvents {
18299
+ export {
18300
+ BaseEvent_5 as BaseEvent,
18301
+ BaseWindowEvent,
18302
+ ViewAttachedEvent,
18303
+ ViewDetachedEvent,
18304
+ WindowViewEvent,
18305
+ AlertRequestedEvent,
18306
+ AuthRequestedEvent,
18307
+ EndLoadEvent,
18308
+ WillRedirectEvent,
18309
+ ReloadedEvent,
18310
+ OptionsChangedEvent,
18311
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18312
+ ExternalProcessExitedEvent,
18313
+ ExternalProcessStartedEvent,
18314
+ HiddenEvent_2 as HiddenEvent,
18315
+ WindowHiddenEvent,
18316
+ PreloadScriptInfoRunning,
18317
+ PreloadScriptInfo,
18318
+ PreloadScriptsStateChangeEvent,
18319
+ UserBoundsChangeEvent,
18320
+ BoundsChangeEvent,
18321
+ WillMoveOrResizeEvent,
18322
+ PerformanceReportEvent,
18323
+ InputEvent_2 as InputEvent,
18324
+ LayoutInitializedEvent,
18325
+ LayoutReadyEvent,
18326
+ BeginUserBoundsChangingEvent,
18327
+ BoundsChangedEvent,
18328
+ BoundsChangingEvent,
18329
+ CloseRequestedEvent,
18330
+ WindowCloseRequestedEvent,
18331
+ ContextChangedEvent,
18332
+ ClosedEvent_2 as ClosedEvent,
18333
+ WindowClosedEvent,
18334
+ ClosingEvent,
18335
+ WindowClosingEvent,
18336
+ DisabledMovementBoundsChangedEvent,
18337
+ DisabledMovementBoundsChangingEvent,
18338
+ EmbeddedEvent,
18339
+ EndUserBoundsChangingEvent,
18340
+ HotkeyEvent_2 as HotkeyEvent,
18341
+ WindowHotkeyEvent,
18342
+ InitializedEvent_2 as InitializedEvent,
18343
+ WindowInitializedEvent,
18344
+ MaximizedEvent,
18345
+ MinimizedEvent,
18346
+ PreloadScriptsStateChangedEvent,
18347
+ PreloadScriptsStateChangingEvent,
18348
+ RestoredEvent,
18349
+ WindowRestoredEvent,
18350
+ ShowRequestedEvent,
18351
+ WindowShowRequestedEvent,
18352
+ ShownEvent_2 as ShownEvent,
18353
+ WindowShownEvent,
18354
+ UserMovementEnabledEvent,
18355
+ UserMovementDisabledEvent,
18356
+ WillMoveEvent,
18357
+ WillResizeEvent,
18358
+ NonPropagatedWindowEvent,
18359
+ ShowAllDownloadsEvent,
18360
+ DownloadShelfVisibilityChangedEvent,
18361
+ WindowSourcedEvent,
18362
+ WillPropagateWindowEvent,
18363
+ Event_6 as Event,
18364
+ WindowEvent,
18365
+ EventType_2 as EventType,
18366
+ WindowEventType,
18367
+ PropagatedEvent_3 as PropagatedEvent,
18368
+ PropagatedWindowEvent,
18369
+ PropagatedWindowEventType,
18370
+ Payload_3 as Payload,
18371
+ ByType_2 as ByType
18372
+ }
18373
+ }
18374
+
18375
+ /**
18376
+ * @deprecated Renamed to {@link EventType}.
18377
+ */
18378
+ declare type WindowEventType = WindowEvent['type'];
18379
+
18380
+ /**
18381
+ * @deprecated Renamed to {@link HiddenEvent}.
18382
+ */
18383
+ declare type WindowHiddenEvent = HiddenEvent_2;
18384
+
18385
+ /**
18386
+ * @deprecated Renamed to {@link HotkeyEvent}.
18387
+ */
18388
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18389
+
18390
+ /**
18391
+ * @interface
18392
+ */
18393
+ declare type WindowInfo = {
18394
+ canNavigateBack: boolean;
18395
+ canNavigateForward: boolean;
18396
+ preloadScripts: Array<any>;
18397
+ title: string;
18398
+ url: string;
18399
+ };
18400
+
18401
+ /**
18402
+ * @deprecated Renamed to {@link InitializedEvent}.
18403
+ */
18404
+ declare type WindowInitializedEvent = InitializedEvent_2;
18405
+
18406
+ /**
18407
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18408
+ */
18409
+ declare class _WindowModule extends Base {
18410
+ /**
18411
+ * Asynchronously returns a Window object that represents an existing window.
18412
+ *
18413
+ * @example
18414
+ * ```js
18415
+ * async function createWin() {
18416
+ * const app = await fin.Application.start({
18417
+ * name: 'myApp',
18418
+ * uuid: 'app-1',
18419
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18420
+ * autoShow: true
18421
+ * });
18422
+ * return await app.getWindow();
18423
+ * }
18424
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18425
+ * .then(win => console.log('wrapped window'))
18426
+ * .catch(err => console.log(err));
18427
+ * ```
18428
+ */
18429
+ wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18430
+ /**
18431
+ * Synchronously returns a Window object that represents an existing window.
18432
+ *
18433
+ * @example
18434
+ * ```js
18435
+ * async function createWin() {
18436
+ * const app = await fin.Application.start({
18437
+ * name: 'myApp',
18438
+ * uuid: 'app-1',
18439
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18440
+ * autoShow: true
18441
+ * });
18442
+ * return await app.getWindow();
18443
+ * }
18444
+ * await createWin();
18445
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18446
+ * ```
18447
+ */
18448
+ wrapSync(identity: OpenFin.Identity): OpenFin.Window;
18449
+ /**
18450
+ * Creates a new Window.
18451
+ * @param options - Window creation options
18452
+ *
18453
+ * @example
18454
+ * ```js
18455
+ * async function createWindow() {
18456
+ * const winOption = {
18457
+ * name:'child',
18458
+ * defaultWidth: 300,
18459
+ * defaultHeight: 300,
18460
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18461
+ * frame: true,
18462
+ * autoShow: true
18463
+ * };
18464
+ * return await fin.Window.create(winOption);
18465
+ * }
18466
+ *
18467
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18468
+ * ```
18469
+ */
18470
+ create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
18471
+ /**
18472
+ * Asynchronously returns a Window object that represents the current window
18473
+ *
18474
+ * @example
18475
+ * ```js
18476
+ * fin.Window.getCurrent()
18477
+ * .then(wnd => console.log('current window'))
18478
+ * .catch(err => console.log(err));
18479
+ *
18480
+ * ```
18481
+ */
18482
+ getCurrent(): Promise<OpenFin.Window>;
18483
+ /**
18484
+ * Synchronously returns a Window object that represents the current window
18485
+ *
18486
+ * @example
18487
+ * ```js
18488
+ * const wnd = fin.Window.getCurrentSync();
18489
+ * const info = await wnd.getInfo();
18490
+ * console.log(info);
18491
+ *
18492
+ * ```
18493
+ */
18494
+ getCurrentSync(): OpenFin.Window;
18495
+ }
18496
+
18497
+ /**
18498
+ * Generated when a child window is not responding.
18499
+ * @interface
18500
+ */
18501
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18502
+ type: 'window-not-responding';
18503
+ };
18504
+
18505
+ /**
18506
+ * @interface
18507
+ */
18508
+ declare type WindowOptionDiff = {
18509
+ [key in keyof WindowOptions]: {
18510
+ oldVal: WindowOptions[key];
18511
+ newVal: WindowOptions[key];
18512
+ };
18513
+ };
18514
+
18515
+ /**
18516
+ * @interface
18517
+ */
18518
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18519
+
18520
+ declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
18521
+
18522
+ /**
18523
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18524
+ */
18525
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18526
+
18527
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18528
+
18529
+ /**
18530
+ * Generated when a child window is responding.
18531
+ * @interface
18532
+ */
18533
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18534
+ type: 'window-responding';
18535
+ };
18536
+
18537
+ /**
18538
+ * @deprecated Renamed to {@link RestoredEvent}.
18539
+ */
18540
+ declare type WindowRestoredEvent = RestoredEvent;
18541
+
18542
+ /**
18543
+ * @deprecated Renamed to {@link ShownEvent}.
18544
+ */
18545
+ declare type WindowShownEvent = ShownEvent_2;
18546
+
18547
+ /**
18548
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18549
+ */
18550
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18551
+
18552
+ /**
18553
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18554
+ * from {@link OpenFin.ViewEvents}.
18555
+ */
18556
+ 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 | WillRedirectEvent | WillResizeEvent | ShowAllDownloadsEvent | DownloadShelfVisibilityChangedEvent;
18557
+
18558
+ /**
18559
+ * Generated when a child window starts loading.
18560
+ * @interface
18561
+ */
18562
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18563
+ type: 'window-start-load';
18564
+ };
18565
+
18566
+ /**
18567
+ * Visibility state of a window.
18568
+ */
18569
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18570
+
18571
+ /**
18572
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18573
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18574
+ */
18575
+ declare type WindowViewEvent = {
18576
+ viewIdentity: OpenFin.Identity;
18577
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18578
+
18579
+ /**
18580
+ * @interface
18581
+ */
18582
+ declare type WindowViewsPrintOptions = {
18583
+ content: 'views';
18584
+ includeSelf?: boolean;
18585
+ };
18586
+
18587
+ declare type Wire = EventEmitter & {
18588
+ connect(messageReciever: MessageReceiver): Promise<any>;
18589
+ connectSync(): any;
18590
+ send(data: any): Promise<any>;
18591
+ shutdown(): Promise<void>;
18592
+ getPort(): string;
18593
+ };
18594
+
18595
+ declare type WireConstructor = {
18596
+ new (onmessage: (data: any) => void): Wire;
18597
+ };
18598
+
18599
+ /* Excluded from this release type: WithId */
18600
+
18601
+ declare interface WithInterop {
18602
+ interop: InteropClient;
18603
+ }
18604
+
18605
+ /* Excluded from this release type: WithoutId */
18606
+
18607
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18608
+ positioningOptions?: OpenFin.PositioningOptions;
18609
+ };
18610
+
18611
+ /* Excluded from this release type: WorkspacePlatformOptions */
18612
+
18613
+ /**
18614
+ * A generic request to write any supported data to the clipboard.
18615
+ * @interface
18616
+ */
18617
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18618
+ /**
18619
+ * Data to be written
18620
+ */
18621
+ data: {
18622
+ text?: string;
18623
+ html?: string;
18624
+ rtf?: string;
18625
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18626
+ };
18627
+
18628
+ /**
18629
+ * @deprecated - instead use WriteAnyClipboardRequest
18630
+ *
18631
+ * A generic request to write any supported data to the clipboard.
18632
+ *
18633
+ * @interface
18634
+ */
18635
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
18636
+
18637
+ /**
18638
+ * A request to write data to the clipboard.
18639
+ * @interface
18640
+ */
18641
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
18642
+ /**
18643
+ * Data to write to the clipboard.
18644
+ */
18645
+ data: string;
18646
+ };
18647
+
18648
+ /**
18649
+ * @interface
18650
+ */
18651
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
18652
+ /**
18653
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
18654
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
18655
+ * Using other image/<format> DataURLs will throw an Error.
18656
+ */
18657
+ image: string;
18658
+ };
18659
+
18660
+ /**
18661
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
18662
+ *
18663
+ * A request to write data to the clipboard.
18664
+ *
18665
+ * @interface
18666
+ */
18667
+ declare type WriteRequestType = WriteClipboardRequest;
18668
+
18669
+ export { }