@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
@@ -195,100 +206,6 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
195
206
  */
196
207
  constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
197
208
  private windowListFromIdentityList;
198
- /**
199
- * Adds a listener to the end of the listeners array for the specified event.
200
- * @param eventType - The type of the event.
201
- * @param listener - Called whenever an event of the specified type occurs.
202
- * @param options - Option to support event timestamps.
203
- *
204
- * @function addListener
205
- * @memberof Application
206
- * @instance
207
- * @tutorial Application.EventEmitter
208
- */
209
- /**
210
- * Adds a listener to the end of the listeners array for the specified event.
211
- * @param eventType - The type of the event.
212
- * @param listener - Called whenever an event of the specified type occurs.
213
- * @param options - Option to support event timestamps.
214
- *
215
- * @function on
216
- * @memberof Application
217
- * @instance
218
- * @tutorial Application.EventEmitter
219
- */
220
- /**
221
- * 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.
222
- * @param eventType - The type of the event.
223
- * @param listener - The callback function.
224
- * @param options - Option to support event timestamps.
225
- *
226
- * @function once
227
- * @memberof Application
228
- * @instance
229
- * @tutorial Application.EventEmitter
230
- */
231
- /**
232
- * Adds a listener to the beginning of the listeners array for the specified event.
233
- * @param eventType - The type of the event.
234
- * @param listener - The callback function.
235
- * @param options - Option to support event timestamps.
236
- *
237
- * @function prependListener
238
- * @memberof Application
239
- * @instance
240
- * @tutorial Application.EventEmitter
241
- */
242
- /**
243
- * 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.
244
- * The listener is added to the beginning of the listeners array.
245
- * @param eventType - The type of the event.
246
- * @param listener - The callback function.
247
- * @param options - Option to support event timestamps.
248
- *
249
- * @function prependOnceListener
250
- * @memberof Application
251
- * @instance
252
- * @tutorial Application.EventEmitter
253
- */
254
- /**
255
- * Remove a listener from the listener array for the specified event.
256
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
257
- * @param eventType - The type of the event.
258
- * @param listener - The callback function.
259
- * @param options - Option to support event timestamps.
260
- *
261
- * @function removeListener
262
- * @memberof Application
263
- * @instance
264
- * @tutorial Application.EventEmitter
265
- */
266
- /**
267
- * Removes all listeners, or those of the specified event.
268
- * @param eventType - The type of the event.
269
- *
270
- * @function removeAllListeners
271
- * @memberof Application
272
- * @instance
273
- * @tutorial Application.EventEmitter
274
- */
275
- /**
276
- * JumpListCategory interface
277
- * @typedef { object } JumpListCategory@typedef { object } JumpListCategory
278
- * @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.
279
- * @property { JumpListItem[] } items Array of JumpListItem objects
280
- */
281
- /**
282
- * @PORTED
283
- * JumpListItem interface
284
- * @typedef { object } JumpListItem@typedef { object } JumpListItem
285
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
286
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
287
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
288
- * @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.
289
- * @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).
290
- * @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.
291
- */
292
209
  /**
293
210
  * Determines if the application is currently running.
294
211
  *
@@ -935,6 +852,7 @@ declare namespace ApplicationEvents {
935
852
  RespondingEvent,
936
853
  StartedEvent,
937
854
  ApplicationSourcedEvent,
855
+ ApplicationSourcedEventType,
938
856
  Event_3 as Event,
939
857
  ApplicationEvent,
940
858
  EventType_3 as EventType,
@@ -1273,10 +1191,13 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1273
1191
  */
1274
1192
  apiDiagnostics: boolean;
1275
1193
  /**
1276
- * Define the file download rules.
1277
- * See [here](https://developers.openfin.co/of-docs/docs/file-download#manifest-properties-for-file-downloads) for more details.
1194
+ * @deprecated Please use {@link domainSettings} instead
1278
1195
  */
1279
1196
  defaultDomainSettings: DefaultDomainSettings;
1197
+ /**
1198
+ * 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.
1199
+ */
1200
+ domainSettings: DomainSettings;
1280
1201
  /**
1281
1202
  * @defaultValue false
1282
1203
  *
@@ -1307,6 +1228,11 @@ declare type ApplicationPermissions = {
1307
1228
  */
1308
1229
  declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1309
1230
 
1231
+ /**
1232
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
1233
+ */
1234
+ declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
1235
+
1310
1236
  declare type ApplicationState = OpenFin.ApplicationState;
1311
1237
 
1312
1238
  /**
@@ -3144,20 +3070,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3144
3070
  connectionUrl: string;
3145
3071
  };
3146
3072
 
3147
- /**
3148
- * @PORTED
3149
- * WriteRequestType interface
3150
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3151
- * @property { string } data Data to be written
3152
- * @property { string } [type] Clipboard Type
3153
- */
3154
- /**
3155
- * @PORTED
3156
- * OpenFin.WriteAnyClipboardRequest interface
3157
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3158
- * @property { string } data Data to be written
3159
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3160
- */
3161
3073
  /**
3162
3074
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3163
3075
  *
@@ -4586,21 +4498,15 @@ declare type CustomRequestHeaders = {
4586
4498
  declare type DataChannelReadyState = RTCDataChannel['readyState'];
4587
4499
 
4588
4500
  /**
4501
+ * @deprecated Use {@link OpenFin.DomainSettings} instead.
4589
4502
  * @interface
4590
4503
  */
4591
- declare type DefaultDomainSettings = {
4592
- rules: DefaultDomainSettingsRule[];
4593
- };
4504
+ declare type DefaultDomainSettings = DomainSettings;
4594
4505
 
4595
4506
  /**
4596
- * @interface
4507
+ * @deprecated Use {@link OpenFin.DomainSettingsRule} instead.
4597
4508
  */
4598
- declare type DefaultDomainSettingsRule = {
4599
- match: string[];
4600
- options: {
4601
- downloadSettings: FileDownloadSettings;
4602
- };
4603
- };
4509
+ declare type DefaultDomainSettingsRule = DomainSettingsRule;
4604
4510
 
4605
4511
  declare interface DesktopAgent {
4606
4512
  open(app: TargetApp, context?: Context): Promise<void>;
@@ -4845,6 +4751,25 @@ declare type DisplayMetadata_3 = {
4845
4751
  readonly glyph?: string;
4846
4752
  };
4847
4753
 
4754
+ /**
4755
+ * @interface
4756
+ * 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.
4757
+ */
4758
+ declare type DomainSettings = {
4759
+ rules: DomainSettingsRule[];
4760
+ };
4761
+
4762
+ /**
4763
+ * @interface
4764
+ */
4765
+ declare type DomainSettingsRule = {
4766
+ match: string[];
4767
+ options: {
4768
+ downloadSettings?: FileDownloadSettings;
4769
+ api?: ApiInjection;
4770
+ };
4771
+ };
4772
+
4848
4773
  /**
4849
4774
  * Metadata returned from a preload script download request.
4850
4775
  *
@@ -5365,7 +5290,7 @@ declare type EventType_7 = Event_10['type'];
5365
5290
  /**
5366
5291
  * Union of possible `type` values for a {@link SystemEvent}.
5367
5292
  */
5368
- declare type EventType_8 = SystemEvent['type'];
5293
+ declare type EventType_8 = Event_11['type'];
5369
5294
 
5370
5295
  /**
5371
5296
  * @internal
@@ -5418,83 +5343,6 @@ declare class ExternalApplication extends EmitterBase<OpenFin.ExternalApplicatio
5418
5343
  * @internal
5419
5344
  */
5420
5345
  constructor(wire: Transport, identity: OpenFin.ApplicationIdentity);
5421
- /**
5422
- * Adds a listener to the end of the listeners array for the specified event.
5423
- * @param eventType - The type of the event.
5424
- * @param listener - Called whenever an event of the specified type occurs.
5425
- * @param options - Option to support event timestamps.
5426
- *
5427
- * @function addListener
5428
- * @memberof ExternalApplication
5429
- * @instance
5430
- * @tutorial ExternalApplication.EventEmitter
5431
- */
5432
- /**
5433
- * Adds a listener to the end of the listeners array for the specified event.
5434
- * @param eventType - The type of the event.
5435
- * @param listener - Called whenever an event of the specified type occurs.
5436
- * @param options - Option to support event timestamps.
5437
- *
5438
- * @function on
5439
- * @memberof ExternalApplication
5440
- * @instance
5441
- * @tutorial ExternalApplication.EventEmitter
5442
- */
5443
- /**
5444
- * 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.
5445
- * @param eventType - The type of the event.
5446
- * @param listener - The callback function.
5447
- * @param options - Option to support event timestamps.
5448
- *
5449
- * @function once
5450
- * @memberof ExternalApplication
5451
- * @instance
5452
- * @tutorial ExternalApplication.EventEmitter
5453
- */
5454
- /**
5455
- * Adds a listener to the beginning of the listeners array for the specified event.
5456
- * @param eventType - The type of the event.
5457
- * @param listener - The callback function.
5458
- * @param options - Option to support event timestamps.
5459
- *
5460
- * @function prependListener
5461
- * @memberof ExternalApplication
5462
- * @instance
5463
- * @tutorial ExternalApplication.EventEmitter
5464
- */
5465
- /**
5466
- * 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.
5467
- * The listener is added to the beginning of the listeners array.
5468
- * @param eventType - The type of the event.
5469
- * @param listener - The callback function.
5470
- * @param options - Option to support event timestamps.
5471
- *
5472
- * @function prependOnceListener
5473
- * @memberof ExternalApplication
5474
- * @instance
5475
- * @tutorial ExternalApplication.EventEmitter
5476
- */
5477
- /**
5478
- * Remove a listener from the listener array for the specified event.
5479
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5480
- * @param eventType - The type of the event.
5481
- * @param listener - The callback function.
5482
- * @param options - Option to support event timestamps.
5483
- *
5484
- * @function removeListener
5485
- * @memberof ExternalApplication
5486
- * @instance
5487
- * @tutorial ExternalApplication.EventEmitter
5488
- */
5489
- /**
5490
- * Removes all listeners, or those of the specified event.
5491
- * @param eventType - The type of the event.
5492
- *
5493
- * @function removeAllListeners
5494
- * @memberof ExternalApplication
5495
- * @instance
5496
- * @tutorial ExternalApplication.EventEmitter
5497
- */
5498
5346
  /**
5499
5347
  * Retrieves information about the external application.
5500
5348
  *
@@ -5939,83 +5787,6 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
5939
5787
  * @internal
5940
5788
  */
5941
5789
  constructor(wire: Transport, identity: OpenFin.Identity);
5942
- /**
5943
- * Adds the listener function to the end of the listeners array for the specified event type.
5944
- * @param eventType - The type of the event.
5945
- * @param listener - Called whenever an event of the specified type occurs.
5946
- * @param options - Option to support event timestamps.
5947
- *
5948
- * @function addListener
5949
- * @memberof Frame
5950
- * @instance
5951
- * @tutorial Frame.EventEmitter
5952
- */
5953
- /**
5954
- * Adds a listener to the end of the listeners array for the specified event.
5955
- * @param eventType - The type of the event.
5956
- * @param listener - Called whenever an event of the specified type occurs.
5957
- * @param options - Option to support event timestamps.
5958
- *
5959
- * @function on
5960
- * @memberof Frame
5961
- * @instance
5962
- * @tutorial Frame.EventEmitter
5963
- */
5964
- /**
5965
- * 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.
5966
- * @param eventType - The type of the event.
5967
- * @param listener - The callback function.
5968
- * @param options - Option to support event timestamps.
5969
- *
5970
- * @function once
5971
- * @memberof Frame
5972
- * @instance
5973
- * @tutorial Frame.EventEmitter
5974
- */
5975
- /**
5976
- * Adds a listener to the beginning of the listeners array for the specified event.
5977
- * @param eventType - The type of the event.
5978
- * @param listener - The callback function.
5979
- * @param options - Option to support event timestamps.
5980
- *
5981
- * @function prependListener
5982
- * @memberof Frame
5983
- * @instance
5984
- * @tutorial Frame.EventEmitter
5985
- */
5986
- /**
5987
- * 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.
5988
- * The listener is added to the beginning of the listeners array.
5989
- * @param eventType - The type of the event.
5990
- * @param listener - The callback function.
5991
- * @param options - Option to support event timestamps.
5992
- *
5993
- * @function prependOnceListener
5994
- * @memberof Frame
5995
- * @instance
5996
- * @tutorial Frame.EventEmitter
5997
- */
5998
- /**
5999
- * Remove a listener from the listener array for the specified event.
6000
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
6001
- * @param eventType - The type of the event.
6002
- * @param listener - The callback function.
6003
- * @param options - Option to support event timestamps.
6004
- *
6005
- * @function removeListener
6006
- * @memberof Frame
6007
- * @instance
6008
- * @tutorial Frame.EventEmitter
6009
- */
6010
- /**
6011
- * Removes all listeners, or those of the specified event.
6012
- * @param eventType - The type of the event.
6013
- *
6014
- * @function removeAllListeners
6015
- * @memberof Frame
6016
- * @instance
6017
- * @tutorial Frame.EventEmitter
6018
- */
6019
5790
  /**
6020
5791
  * Returns a frame info object for the represented frame.
6021
5792
  *
@@ -6940,6 +6711,13 @@ declare type InitPlatformOptions = {
6940
6711
  interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
6941
6712
  };
6942
6713
 
6714
+ /**
6715
+ * * 'none': The `fin` API will be not available from within this context.
6716
+ * * 'global': The entire `fin` API will be available from within this context.
6717
+ * @defaultValue 'global'
6718
+ */
6719
+ declare type InjectionType = 'none' | 'global';
6720
+
6943
6721
  /**
6944
6722
  * Generated when the value of the element changes.
6945
6723
  * @interface
@@ -7299,56 +7077,6 @@ declare class InteropBroker extends Base {
7299
7077
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7300
7078
  new (): InteropBroker;
7301
7079
  };
7302
- /**
7303
- * @REMOVED
7304
- * SetContextOptions interface
7305
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
7306
- * @property { Context } {context} - New context to set.
7307
- */
7308
- /**
7309
- * @REMOVED
7310
- * GetContextOptions interface
7311
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
7312
- * @property { string } [contextType] - Context Type
7313
- */
7314
- /**
7315
- * @REMOVED
7316
- * JoinContextGroupOptions interface
7317
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
7318
- * @property { string } contextGroupId - Id of the context group.
7319
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
7320
- */
7321
- /**
7322
- * @REMOVED
7323
- * AddClientToContextGroupOptions interface
7324
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
7325
- * @property { string } contextGroupId - Name of the context group.
7326
- */
7327
- /**
7328
- * @REMOVED
7329
- * RemoveFromContextGroupOptions interface
7330
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
7331
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
7332
- */
7333
- /**
7334
- * @REMOVED
7335
- * GetInfoForContextGroupOptions interface
7336
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
7337
- * @property { string } contextGroupId - Name of the context group to get info for.
7338
- */
7339
- /**
7340
- * @REMOVED
7341
- * GetAllClientsInContextGroupOptions interface
7342
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
7343
- * @property { string } contextGroupId - Name of the context group to get info for.
7344
- */
7345
- /**
7346
- * @PORTED
7347
- * InfoForIntentOptions interface
7348
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
7349
- * @property { string } name Name of the intent to get info for.
7350
- * @property { Context } [context] Optional context.
7351
- */
7352
7080
  /**
7353
7081
  * Sets a context for the context group of the incoming current entity.
7354
7082
  * @param setContextOptions - New context to set.
@@ -7848,95 +7576,6 @@ declare type InteropBrokerOptions = {
7848
7576
  logging?: InteropLoggingOptions;
7849
7577
  };
7850
7578
 
7851
- /**
7852
- * @PORTED
7853
- * @typedef { object } Intent
7854
- * @summary The combination of an action and a context that is passed to an application for resolution.
7855
- * @property { string } name Name of the intent.
7856
- * @property { Context } context Data associated with the intent
7857
- */
7858
- /**
7859
- * @REMOVED
7860
- * @typedef { object } Subscription
7861
- * @summary Object returned when subscribing a handler.
7862
- * @property { function } unsubscribe Function to unsubscribe the handler.
7863
- */
7864
- /**
7865
- * @typedef { function } ContextHandler
7866
- * @summary Subscription function for addContextHandler.
7867
- */
7868
- /**
7869
- * @typedef { function } IntentHandler
7870
- * @summary Subscription function for registerIntentHandler
7871
- */
7872
- /**
7873
- * @PORTED
7874
- * @typedef { object } ClientIdentity
7875
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7876
- * @property {string} uuid GUID of an application.
7877
- * @property {string} name Name of an entity in an application.
7878
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7879
- */
7880
- /**
7881
- * @PORTED
7882
- * @typedef { object } ContextGroupInfo
7883
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7884
- * @property {string} id Name of the context group
7885
- * @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.
7886
- */
7887
- /**
7888
- * @PORTED
7889
- * @typedef { object } DisplayMetadata
7890
- * @summary The display data for a Context Group.
7891
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7892
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7893
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7894
- */
7895
- /**
7896
- * @PORTED
7897
- * @typedef { object } Context
7898
- * @summary Data passed between entities and applications.
7899
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7900
- * @property {string} [name] User-readable name for the incoming context.
7901
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7902
- */
7903
- /**
7904
- * @REMOVED
7905
- * @typedef { object } ContextForIntent
7906
- * @summary Data passed between entities and applications, including an optional metadata.
7907
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7908
- * @property {string} [name] User-readable name for the incoming context.
7909
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7910
- * @property {any} [metadata]
7911
- */
7912
- /**
7913
- * @REMOVED
7914
- * @typedef { object } SessionContextGroup
7915
- * @summary An instance of a SessionContextGroup
7916
- * @property {string} id The SessionContextGroup's id.
7917
- * @property {setContext} setContext Sets a context of a certain type
7918
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7919
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7920
- */
7921
- /**
7922
- * @typedef {function} setContext
7923
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7924
- * @param context The Context to be set.
7925
- *
7926
- */
7927
- /**
7928
- * @typedef {function} getCurrentContext
7929
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7930
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7931
- *
7932
- */
7933
- /**
7934
- * @typedef {function} addContextHandler
7935
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7936
- * @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.
7937
- * @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.
7938
- *
7939
- */
7940
7579
  /**
7941
7580
  * The Interop Client API is broken up into two groups:
7942
7581
  *
@@ -8378,13 +8017,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8378
8017
  */
8379
8018
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8380
8019
 
8381
- /**
8382
- * @PORTED
8383
- * @typedef { object } InteropConfig
8384
- * @summary Information relevant to the Interop Broker.
8385
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
8386
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
8387
- */
8388
8020
  /**
8389
8021
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8390
8022
  *
@@ -9538,7 +9170,7 @@ declare type LayoutOptions = {
9538
9170
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9539
9171
 
9540
9172
  /**
9541
- * @interface
9173
+ * Layout preset type.
9542
9174
  */
9543
9175
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9544
9176
 
@@ -10351,7 +9983,7 @@ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'c
10351
9983
  *
10352
9984
  * Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
10353
9985
  */
10354
- declare type NotRequested<EventType extends String> = EventType extends `${infer U}-requested` ? never : EventType;
9986
+ declare type NotRequested<EventType extends String> = EventType extends `${string}-requested` ? never : EventType;
10355
9987
 
10356
9988
  /**
10357
9989
  * Generated when an application is not responding.
@@ -10463,6 +10095,7 @@ declare namespace OpenFin {
10463
10095
  ResizeRegion,
10464
10096
  Accelerator,
10465
10097
  Api,
10098
+ InjectionType,
10466
10099
  NavigationRules,
10467
10100
  ContentNavigation,
10468
10101
  ContentRedirect,
@@ -10610,6 +10243,9 @@ declare namespace OpenFin {
10610
10243
  RuntimeInfo,
10611
10244
  DefaultDomainSettings,
10612
10245
  DefaultDomainSettingsRule,
10246
+ DomainSettings,
10247
+ ApiInjection,
10248
+ DomainSettingsRule,
10613
10249
  FileDownloadBehaviorNames,
10614
10250
  FileDownloadSettings,
10615
10251
  DownloadRule,
@@ -14123,83 +13759,6 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
14123
13759
  */
14124
13760
  constructor(wire: Transport);
14125
13761
  private sendExternalProcessRequest;
14126
- /**
14127
- * Adds a listener to the end of the listeners array for the specified event.
14128
- * @param eventType - The type of the event.
14129
- * @param listener - Called whenever an event of the specified type occurs.
14130
- * @param options - Option to support event timestamps.
14131
- *
14132
- * @function addListener
14133
- * @memberof System
14134
- * @instance
14135
- * @tutorial System.EventEmitter
14136
- */
14137
- /**
14138
- * Adds a listener to the end of the listeners array for the specified event.
14139
- * @param eventType - The type of the event.
14140
- * @param listener - Called whenever an event of the specified type occurs.
14141
- * @param options - Option to support event timestamps.
14142
- *
14143
- * @function on
14144
- * @memberof System
14145
- * @instance
14146
- * @tutorial System.EventEmitter
14147
- */
14148
- /**
14149
- * 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.
14150
- * @param eventType - The type of the event.
14151
- * @param listener - The callback function.
14152
- * @param options - Option to support event timestamps.
14153
- *
14154
- * @function once
14155
- * @memberof System
14156
- * @instance
14157
- * @tutorial System.EventEmitter
14158
- */
14159
- /**
14160
- * Adds a listener to the beginning of the listeners array for the specified event.
14161
- * @param eventType - The type of the event.
14162
- * @param listener - The callback function.
14163
- * @param options - Option to support event timestamps.
14164
- *
14165
- * @function prependListener
14166
- * @memberof System
14167
- * @instance
14168
- * @tutorial System.EventEmitter
14169
- */
14170
- /**
14171
- * 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.
14172
- * The listener is added to the beginning of the listeners array.
14173
- * @param eventType - The type of the event.
14174
- * @param listener - The callback function.
14175
- * @param options - Option to support event timestamps.
14176
- *
14177
- * @function prependOnceListener
14178
- * @memberof System
14179
- * @instance
14180
- * @tutorial System.EventEmitter
14181
- */
14182
- /**
14183
- * Remove a listener from the listener array for the specified event.
14184
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
14185
- * @param eventType - The type of the event.
14186
- * @param listener - The callback function.
14187
- * @param options - Option to support event timestamps.
14188
- *
14189
- * @function removeListener
14190
- * @memberof System
14191
- * @instance
14192
- * @tutorial System.EventEmitter
14193
- */
14194
- /**
14195
- * Removes all listeners, or those of the specified event.
14196
- * @param eventType - The type of the event.
14197
- *
14198
- * @function removeAllListeners
14199
- * @memberof System
14200
- * @instance
14201
- * @tutorial System.EventEmitter
14202
- */
14203
13762
  /**
14204
13763
  * Returns the version of the runtime. The version contains the major, minor,
14205
13764
  * build and revision numbers.
@@ -16234,169 +15793,6 @@ declare type VerboseWebPermission = {
16234
15793
 
16235
15794
  declare type View = OpenFin.View;
16236
15795
 
16237
- /**
16238
- * @PORTED
16239
- * @typedef {object} View~options
16240
- * @summary View creation options.
16241
- * @desc This is the options object required by {@link View.create View.create}.
16242
- *
16243
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
16244
- * (defaults to `"about:blank"` when omitted).
16245
- *
16246
- * @property {object} [experimental]
16247
- * Configurations for API injection.
16248
- *
16249
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
16250
- *
16251
- * @property {object} [accelerator]
16252
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
16253
- *
16254
- * @property {boolean} [accelerator.devtools=false]
16255
- * If `true`, enables the devtools keyboard shortcut:<br>
16256
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
16257
- *
16258
- * @property {boolean} [accelerator.reload=false]
16259
- * If `true`, enables the reload keyboard shortcuts:<br>
16260
- * `Ctrl` + `R` _(Windows)_<br>
16261
- * `F5` _(Windows)_<br>
16262
- * `Command` + `R` _(Mac)_
16263
- *
16264
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
16265
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
16266
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
16267
- * `Shift` + `F5` _(Windows)_<br>
16268
- * `Command` + `Shift` + `R` _(Mac)_
16269
- *
16270
- * @property {boolean} [accelerator.zoom=false]
16271
- * If `true`, enables the zoom keyboard shortcuts:<br>
16272
- * `Ctrl` + `+` _(Zoom In)_<br>
16273
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
16274
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
16275
- * `Ctrl` + `-` _(Zoom Out)_<br>
16276
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
16277
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
16278
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
16279
- * `Ctrl` + `0` _(Restore to 100%)_
16280
- *
16281
- * @property {object} [api]
16282
- * Configurations for API injection.
16283
- *
16284
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
16285
- *
16286
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
16287
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
16288
- *
16289
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
16290
- * Autoplay policy to apply to content in the window, can be
16291
- * `no-user-gesture-required`, `user-gesture-required`,
16292
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
16293
- *
16294
- * @property {object} [autoResize] AutoResize options
16295
- *
16296
- * @property {object} [bounds] initial bounds given relative to the window.
16297
- *
16298
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
16299
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
16300
- * (`document.body.style.backgroundColor`),
16301
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
16302
- * areas when growing a window. Setting
16303
- * this value to the anticipated content background color can help improve user experience.
16304
- * Default is white.
16305
- *
16306
- * @property {object} [contentNavigation]
16307
- * Restrict navigation to URLs that match an allowed pattern.
16308
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
16309
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
16310
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
16311
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
16312
- *
16313
- * @property {object} [contentRedirect]
16314
- * Restrict redirects to URLs that match an allowed pattern.
16315
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
16316
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
16317
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
16318
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
16319
- *
16320
- * @property {object} [contextMenuSettings] - _Updatable._
16321
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
16322
- * Configure the context menu when right-clicking on a view.
16323
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
16324
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
16325
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
16326
- *
16327
- * @property {object} [contextMenuOptions] - _Updatable._
16328
- * Configure the context menu when right-clicking on a view. Supported menu items:
16329
- * 'separator'
16330
- * 'cut'
16331
- * 'copy'
16332
- * 'copyImage',
16333
- * 'paste'
16334
- * 'spellCheck'
16335
- * 'inspect'
16336
- * 'reload'
16337
- * 'navigateForward'
16338
- * 'navigateBack'
16339
- * 'print'
16340
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
16341
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
16342
- *
16343
- * @property {any} [customData=""] - _Updatable._
16344
- * A field that the user can attach serializable data to be ferried around with the view options.
16345
- * _When omitted, the default value of this property is the empty string (`""`)._
16346
- *
16347
- * @property {any} [customContext=""] - _Updatable._
16348
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
16349
- * is called.
16350
- * When omitted, the default value of this property is the empty string (`""`).
16351
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
16352
- *
16353
- * @property {object[]} [hotkeys=[]] - _Updatable._
16354
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
16355
- * Within Platform, OpenFin also implements a set of pre-defined actions called
16356
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
16357
- * that can be assigned to a specific hotkey in the platform manifest.
16358
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
16359
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
16360
- *
16361
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
16362
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
16363
- * if the view isn't part of the new layout when running `Layout.replace`.
16364
- *
16365
- * @property {string} name
16366
- * The name of the view.
16367
- *
16368
- * @property {boolean} [detachOnClose=false] - _Updatable._
16369
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
16370
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
16371
- *
16372
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
16373
- * but the properties in the manifest will take precedence if there is any collision.
16374
- *
16375
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
16376
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
16377
- * from the parent application.
16378
- *
16379
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
16380
- *
16381
- * @property {string} [processAffinity=<application uuid>]
16382
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
16383
- *
16384
- * @property {boolean} [spellCheck=false]
16385
- * Enable spell check in input text fields for the view.
16386
- *
16387
- * @property {Identity} [target]
16388
- * The identity of the window this view should be attached to.
16389
- *
16390
- * @property {string} [url="about:blank"]
16391
- * The URL of the view.
16392
- *
16393
- * @property {string} [uuid=<application uuid>]
16394
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
16395
- * If omitted, defaults to the `uuid` of the application spawning the view.
16396
- * If given, must match the `uuid` of the application spawning the view.
16397
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
16398
- * really no need to provide it.
16399
- */
16400
15796
  /**
16401
15797
  * A View can be used to embed additional web content into a Window.
16402
15798
  * It is like a child window, except it is positioned relative to its owning window.
@@ -18226,476 +17622,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
18226
17622
  type: 'will-resize';
18227
17623
  };
18228
17624
 
18229
- /**
18230
- * @PORTED
18231
- * @typedef { object } Margins@typedef { object } Margins
18232
- * @property { string } [marginType]
18233
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
18234
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
18235
- *
18236
- * @property { number } [top] The top margin of the printed web page, in pixels.
18237
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
18238
- * @property { number } [left] The left margin of the printed web page, in pixels.
18239
- * @property { number } [right] The right margin of the printed web page, in pixels.
18240
- */
18241
- /**
18242
- * @PORTED
18243
- * @typedef { object } Dpi@typedef { object } Dpi
18244
- * @property { number } [horizontal] The horizontal dpi
18245
- * @property { number } [vertical] The vertical dpi
18246
- */
18247
- /**
18248
- * @PORTED
18249
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
18250
- * @property { boolean } [silent=false] Don't ask user for print settings.
18251
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
18252
- * @property { string } [deviceName=''] Set the printer device name to use.
18253
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
18254
- * @property { Margins } [margins] Set margins for the printed web page
18255
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
18256
- * @property { number } [scaleFactor] The scale factor of the web page.
18257
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
18258
- * @property { boolean } [collate] Whether the web page should be collated.
18259
- * @property { number } [copies] The number of copies of the web page to print.
18260
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
18261
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
18262
- * @property { Dpi } [dpi] Set dpi for the printed web page
18263
- */
18264
- /**
18265
- * @REMOVED
18266
- * PrinterInfo interface
18267
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
18268
- * @property { string } name Printer Name
18269
- * @property { string } description Printer Description
18270
- * @property { number } status Printer Status
18271
- * @property { boolean } isDefault Indicates that system's default printer
18272
- */
18273
- /**
18274
- * @REMOVED
18275
- * SharedWorkerInfo interface
18276
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
18277
- * @property { string } id The unique id of the shared worker.
18278
- * @property { string } url The url of the shared worker.
18279
- */
18280
- /**
18281
- * @PORTED
18282
- * ContentCreationRule interface
18283
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
18284
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
18285
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
18286
- * @property { object } options Window creation options or View creation options.
18287
- */
18288
- /**
18289
- * @PORTED
18290
- * @typedef {object} Window~options
18291
- * @summary Window creation options.
18292
- * @desc This is the options object required by {@link Window.create Window.create}.
18293
- *
18294
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18295
- * (defaults to `"about:blank"` when omitted).
18296
- *
18297
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
18298
- *
18299
- * @property {object} [accelerator]
18300
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
18301
- *
18302
- * @property {boolean} [accelerator.devtools=false]
18303
- * If `true`, enables the devtools keyboard shortcut:<br>
18304
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
18305
- *
18306
- * @property {boolean} [accelerator.reload=false]
18307
- * If `true`, enables the reload keyboard shortcuts:<br>
18308
- * `Ctrl` + `R` _(Windows)_<br>
18309
- * `F5` _(Windows)_<br>
18310
- * `Command` + `R` _(Mac)_
18311
- *
18312
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
18313
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
18314
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
18315
- * `Shift` + `F5` _(Windows)_<br>
18316
- * `Command` + `Shift` + `R` _(Mac)_
18317
- *
18318
- * @property {boolean} [accelerator.zoom=false]
18319
- * 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.
18320
- * If `true`, enables the zoom keyboard shortcuts:<br>
18321
- * `Ctrl` + `+` _(Zoom In)_<br>
18322
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
18323
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
18324
- * `Ctrl` + `-` _(Zoom Out)_<br>
18325
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
18326
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
18327
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
18328
- * `Ctrl` + `0` _(Restore to 100%)_
18329
- *
18330
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
18331
- * <br>
18332
- * alphaMask turns anything of matching RGB value transparent.
18333
- * <br>
18334
- * Caveats:
18335
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
18336
- * * User cannot click-through transparent regions
18337
- * * Not supported on Mac
18338
- * * Windows Aero must be enabled
18339
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
18340
- * * Not supported on rounded corner windows
18341
- * @property {number} [alphaMask.red=-1] 0-255
18342
- * @property {number} [alphaMask.green=-1] 0-255
18343
- * @property {number} [alphaMask.blue=-1] 0-255
18344
- *
18345
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
18346
- * A flag to always position the window at the top of the window stack.
18347
- *
18348
- * @property {object} [api]
18349
- * Configurations for API injection.
18350
- *
18351
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
18352
- *
18353
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
18354
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
18355
- *
18356
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
18357
- *
18358
- * @property {number} [aspectRatio=0] - _Updatable._
18359
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
18360
- * an aspect ratio will not be enforced.
18361
- *
18362
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
18363
- * Autoplay policy to apply to content in the window, can be
18364
- * `no-user-gesture-required`, `user-gesture-required`,
18365
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
18366
- *
18367
- * @property {boolean} [autoShow=true]
18368
- * A flag to automatically show the window when it is created.
18369
- *
18370
- * @property {string} [backgroundColor="#FFF"]
18371
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
18372
- * (`document.body.style.backgroundColor`),
18373
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
18374
- * areas when growing a window. Setting
18375
- * this value to the anticipated content background color can help improve user experience.
18376
- * Default is white.
18377
- *
18378
- * @property {object} [contentCreation]
18379
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
18380
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
18381
- *
18382
- * @property {object} [contentNavigation]
18383
- * Restrict navigation to URLs that match an allowed pattern.
18384
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
18385
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
18386
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
18387
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
18388
- *
18389
- * @property {object} [contentRedirect]
18390
- * Restrict redirects to URLs that match an allowed pattern.
18391
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
18392
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
18393
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
18394
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
18395
- *
18396
- * @property {boolean} [contextMenu=true] - _Updatable._
18397
- * A flag to show the context menu when right-clicking on a window.
18398
- * Gives access to the devtools for the window.
18399
- *
18400
- * @property {object} [contextMenuSettings] - _Updatable._
18401
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
18402
- * Configure the context menu when right-clicking on a window.
18403
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
18404
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
18405
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
18406
- *
18407
- * @property {object} [contextMenuOptions] - _Updatable._
18408
- * Configure the context menu when right-clicking on a window. Supported menu items:
18409
- * 'separator'
18410
- * 'cut'
18411
- * 'copy'
18412
- * 'paste'
18413
- * 'spellCheck'
18414
- * 'inspect'
18415
- * 'reload'
18416
- * 'navigateForward'
18417
- * 'navigateBack'
18418
- * 'print'
18419
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
18420
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
18421
- *
18422
- * @property {object} [cornerRounding] - _Updatable._
18423
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
18424
- * average of _height_ and _width_.
18425
- * @property {number} [cornerRounding.height=0] The height in pixels.
18426
- * @property {number} [cornerRounding.width=0] The width in pixels.
18427
- *
18428
- * @property {any} [customContext=""] - _Updatable. Inheritable._
18429
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
18430
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
18431
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
18432
- * _When omitted, _inherits_ from the parent application._
18433
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
18434
- *
18435
- * @property {any} [customData=""] - _Updatable. Inheritable._
18436
- * A field that the user can attach serializable data to be ferried around with the window options.
18437
- * _When omitted, _inherits_ from the parent application._
18438
- *
18439
- * @property {object[]} [customRequestHeaders]
18440
- * Defines list of custom headers for requests sent by the window.
18441
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
18442
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
18443
- * where the object key is the name of header and value at key is the value of the header
18444
- *
18445
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
18446
- * Toggling off would keep the Window alive even if all its Views were closed.
18447
- * This is meant for advanced users and should be used with caution.
18448
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
18449
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
18450
- * ** note ** - This option is ignored in non-Platforms apps.
18451
- *
18452
- * @property {boolean} [defaultCentered=false]
18453
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
18454
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
18455
- * somewhat above center vertically.
18456
- *
18457
- * @property {number} [defaultHeight=500]
18458
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
18459
- * in favor of the cached value.
18460
- *
18461
- * @property {number} [defaultLeft=100]
18462
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18463
- * launches in favor of the cached value.
18464
- *
18465
- * @property {number} [defaultTop=100]
18466
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18467
- * launches in favor of the cached value.
18468
- *
18469
- * @property {number} [defaultWidth=800]
18470
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18471
- * launches in favor of the cached value.
18472
- *
18473
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
18474
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
18475
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
18476
- *
18477
- * @property {boolean} [frame=true] - _Updatable._
18478
- * A flag to show the frame.
18479
- *
18480
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
18481
- *
18482
- * @property {object[]} [hotkeys=[]] - _Updatable._
18483
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
18484
- * Within Platform, OpenFin also implements a set of pre-defined actions called
18485
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
18486
- * that can be assigned to a specific hotkey in the platform manifest.
18487
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
18488
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
18489
- *
18490
- * @property {string} [icon] - _Updatable. Inheritable._
18491
- * A URL for the icon to be shown in the window title bar and the taskbar.
18492
- * When omitted, inherits from the parent application._
18493
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
18494
- *
18495
- * @property {number} [maxHeight=-1] - _Updatable._
18496
- * The maximum height of a window. Will default to the OS defined value if set to -1.
18497
- *
18498
- * @property {boolean} [maximizable=true] - _Updatable._
18499
- * A flag that lets the window be maximized.
18500
- *
18501
- * @property {number} [maxWidth=-1] - _Updatable._
18502
- * The maximum width of a window. Will default to the OS defined value if set to -1.
18503
- *
18504
- * @property {number} [minHeight=0] - _Updatable._
18505
- * The minimum height of a window.
18506
- *
18507
- * @property {boolean} [minimizable=true] - _Updatable._
18508
- * A flag that lets the window be minimized.
18509
- *
18510
- * @property {number} [minWidth=0] - _Updatable._
18511
- * The minimum width of a window.
18512
- *
18513
- * @property {Identity} [modalParentIdentity]
18514
- * Parent identity of a modal window. It will create a modal child window when this option is set.
18515
- *
18516
- * @property {string} name
18517
- * The name of the window.
18518
- *
18519
- * @property {number} [opacity=1.0] - _Updatable._
18520
- * A flag that specifies how transparent the window will be.
18521
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
18522
- * This value is clamped between `0.0` and `1.0`.
18523
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
18524
- *
18525
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
18526
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
18527
- * from the parent application.
18528
- *
18529
- * @property {string} [processAffinity]
18530
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
18531
- *
18532
- * @property {boolean} [resizable=true] - _Updatable._
18533
- * A flag to allow the user to resize the window.
18534
- *
18535
- * @property {object} [resizeRegion] - _Updatable._
18536
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
18537
- * @property {number} [resizeRegion.bottomRightCorner=9]
18538
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
18539
- * @property {number} [resizeRegion.size=7]
18540
- * The size in pixels.
18541
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
18542
- * Sides that a window can be resized from.
18543
- *
18544
- * @property {boolean} [saveWindowState=true]
18545
- * A flag to cache the location of the window.
18546
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
18547
- *
18548
- * @property {boolean} [ignoreSavedWindowState]
18549
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
18550
- *
18551
- * @property {boolean} [shadow=false]
18552
- * A flag to display a shadow on frameless windows.
18553
- * `shadow` and `cornerRounding` are mutually exclusive.
18554
- * On Windows 7, Aero theme is required.
18555
- *
18556
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
18557
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
18558
- * This occurs when the window is resizing or a tab is being dragged within the layout.
18559
- *
18560
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
18561
- * A flag to show the window's icon in the taskbar.
18562
- *
18563
- * @property {boolean} [smallWindow=false]
18564
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
18565
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
18566
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
18567
- *
18568
- * @property {boolean} [spellCheck=false]
18569
- * Enable spell check in input text fields for the window.
18570
- *
18571
- * @property {string} [state="normal"]
18572
- * The visible state of the window on creation.
18573
- * One of:
18574
- * * `"maximized"`
18575
- * * `"minimized"`
18576
- * * `"normal"`
18577
- *
18578
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
18579
- *
18580
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
18581
- * Specify a taskbar group for the window.
18582
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
18583
- *
18584
- * @property {string} [url="about:blank"]
18585
- * The URL of the window.
18586
- *
18587
- * @property {string} [uuid=<application uuid>]
18588
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
18589
- * If omitted, defaults to the `uuid` of the application spawning the window.
18590
- * If given, must match the `uuid` of the application spawning the window.
18591
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
18592
- * really no need to provide it.
18593
- *
18594
- * @property {boolean} [waitForPageLoad=false]
18595
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
18596
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
18597
- *
18598
- * @property {ViewVisibility} [viewVisibility]
18599
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18600
- */
18601
- /**
18602
- * @PORTED
18603
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18604
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
18605
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18606
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
18607
- */
18608
- /**
18609
- * @PORTED
18610
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
18611
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
18612
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
18613
- */
18614
- /**
18615
- * @REMOVED
18616
- * @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.
18617
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
18618
- */
18619
- /**
18620
- * @REMOVED
18621
- * @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.
18622
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
18623
- */
18624
- /**
18625
- * @PORTED
18626
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
18627
- * @property { Area } [area] The area of the window to be captured.
18628
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
18629
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
18630
- */
18631
- /**
18632
- * @PORTED
18633
- * @typedef { object } Area@typedef { object } Area
18634
- * @property { number } height Area's height
18635
- * @property { number } width Area's width
18636
- * @property { number } x X coordinate of area's starting point
18637
- * @property { number } y Y coordinate of area's starting point
18638
- */
18639
- /**
18640
- * @PORTED
18641
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
18642
- * @property {boolean} [forward=true] Whether to search forward or backward.
18643
- * @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.
18644
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
18645
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
18646
- * @property {boolean} [medialCapitalAsWordStart=false]
18647
- * 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>
18648
- * lowercase or non-letter. Accepts several other intra-word matches.
18649
- */
18650
- /**
18651
- * @REMOVED
18652
- * @typedef {object} Transition@typedef {object} Transition
18653
- * @property {Opacity} opacity - The Opacity transition
18654
- * @property {Position} position - The Position transition
18655
- * @property {Size} size - The Size transition
18656
- */
18657
- /**
18658
- * @PORTED
18659
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
18660
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
18661
- this animation onto the end of the animation queue.
18662
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18663
- */
18664
- /**
18665
- * @PORTED
18666
- * @typedef {object} Size@typedef {object} Size
18667
- * @property {number} duration - The total time in milliseconds this transition should take.
18668
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18669
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
18670
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
18671
- */
18672
- /**
18673
- * @PORTED
18674
- * @typedef {object} Position@typedef {object} Position
18675
- * @property {number} duration - The total time in milliseconds this transition should take.
18676
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18677
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
18678
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
18679
- */
18680
- /**
18681
- * @PORTED
18682
- * @typedef {object} Opacity@typedef {object} Opacity
18683
- * @property {number} duration - The total time in milliseconds this transition should take.
18684
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18685
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
18686
- */
18687
- /**
18688
- * @REMOVED
18689
- * Bounds is a interface that has the properties of height,
18690
- * width, left, top which are all numbers
18691
- * @typedef { object } Bounds@typedef { object } Bounds
18692
- * @property { number } height Get the application height bound
18693
- * @property { number } width Get the application width bound
18694
- * @property { number } top Get the application top bound
18695
- * @property { number } left Get the application left bound
18696
- * @property { number } right Get the application right bound
18697
- * @property { number } bottom Get the application bottom bound
18698
- */
18699
17625
  /**
18700
17626
  * A basic window that wraps a native HTML window. Provides more fine-grained
18701
17627
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18708,83 +17634,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
18708
17634
  * @internal
18709
17635
  */
18710
17636
  constructor(wire: Transport, identity: OpenFin.Identity);
18711
- /**
18712
- * Adds a listener to the end of the listeners array for the specified event.
18713
- * @param eventType - The type of the event.
18714
- * @param listener - Called whenever an event of the specified type occurs.
18715
- * @param options - Option to support event timestamps.
18716
- *
18717
- * @function addListener
18718
- * @memberof Window
18719
- * @instance
18720
- * @tutorial Window.EventEmitter
18721
- */
18722
- /**
18723
- * Adds a listener to the end of the listeners array for the specified event.
18724
- * @param eventType - The type of the event.
18725
- * @param listener - Called whenever an event of the specified type occurs.
18726
- * @param options - Option to support event timestamps.
18727
- *
18728
- * @function on
18729
- * @memberof Window
18730
- * @instance
18731
- * @tutorial Window.EventEmitter
18732
- */
18733
- /**
18734
- * 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.
18735
- * @param eventType - The type of the event.
18736
- * @param listener - The callback function.
18737
- * @param options - Option to support event timestamps.
18738
- *
18739
- * @function once
18740
- * @memberof Window
18741
- * @instance
18742
- * @tutorial Window.EventEmitter
18743
- */
18744
- /**
18745
- * Adds a listener to the beginning of the listeners array for the specified event.
18746
- * @param eventType - The type of the event.
18747
- * @param listener - The callback function.
18748
- * @param options - Option to support event timestamps.
18749
- *
18750
- * @function prependListener
18751
- * @memberof Window
18752
- * @instance
18753
- * @tutorial Window.EventEmitter
18754
- */
18755
- /**
18756
- * 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.
18757
- * The listener is added to the beginning of the listeners array.
18758
- * @param eventType - The type of the event.
18759
- * @param listener - The callback function.
18760
- * @param options - Option to support event timestamps.
18761
- *
18762
- * @function prependOnceListener
18763
- * @memberof Window
18764
- * @instance
18765
- * @tutorial Window.EventEmitter
18766
- */
18767
- /**
18768
- * Remove a listener from the listener array for the specified event.
18769
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
18770
- * @param eventType - The type of the event.
18771
- * @param listener - The callback function.
18772
- * @param options - Option to support event timestamps.
18773
- *
18774
- * @function removeListener
18775
- * @memberof Window
18776
- * @instance
18777
- * @tutorial Window.EventEmitter
18778
- */
18779
- /**
18780
- * Removes all listeners, or those of the specified event.
18781
- * @param eventType - The type of the event.
18782
- *
18783
- * @function removeAllListeners
18784
- * @memberof Window
18785
- * @instance
18786
- * @tutorial Window.EventEmitter
18787
- */
18788
17637
  /**
18789
17638
  * create a new window
18790
17639
  * @internal
@@ -19629,28 +18478,6 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19629
18478
  * ```
19630
18479
  */
19631
18480
  authenticate(userName: string, password: string): Promise<void>;
19632
- /**
19633
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
19634
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
19635
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
19636
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
19637
- */
19638
- /**
19639
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
19640
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
19641
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
19642
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
19643
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
19644
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
19645
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
19646
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
19647
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
19648
- */
19649
- /**
19650
- * @typedef {object} MenuResult@typedef {object} MenuResult
19651
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
19652
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
19653
- */
19654
18481
  /**
19655
18482
  * Shows a menu on the window.
19656
18483
  *
@@ -19747,590 +18574,565 @@ declare class _Window extends WebContents<OpenFin.WindowEvent> {
19747
18574
  */
19748
18575
  closePopupMenu(): Promise<void>;
19749
18576
  /**
19750
- * @PORTED
19751
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19752
- * @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.
19753
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19754
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19755
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19756
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19757
- * @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.
19758
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19759
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19760
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19761
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19762
- * @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.
19763
- * @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`.
19764
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19765
- * @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.
19766
- */
19767
- /**
19768
- * @PORTED
19769
- * @typedef {object} PopupResult@typedef {object} PopupResult
19770
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19771
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19772
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19773
- */
19774
- /**
19775
- * Dispatch a result to the caller of `showPopupWindow`.
19776
- *
19777
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19778
- * @param data Serializable data to send to the caller window.
19779
- *
19780
- * @example
19781
- * ```js
19782
- * await fin.me.dispatchPopupResult({
19783
- * foo: 'bar'
19784
- * });
19785
- * ```
19786
- */
19787
- dispatchPopupResult(data: any): Promise<void>;
19788
- /**
19789
- * Prints the contents of the window.
19790
- *
19791
- * @param options Configuration for the print task.
19792
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19793
- * and the default settings for printing.
19794
- *
19795
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19796
- *
19797
- * @example
19798
- * ```js
19799
- * const win = fin.Window.getCurrentSync();
19800
- *
19801
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19802
- * console.log('print call has been sent to the system');
19803
- * });
19804
- * ```
19805
- *
19806
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19807
- * use the `content` option:
19808
- *
19809
- * ```js
19810
- * const win = fin.Window.getCurrentSync();
19811
- *
19812
- * // Print embedded views
19813
- * win.print({ content: 'views' });
19814
- *
19815
- * // Print screenshot of current window
19816
- * win.print({ content: 'screenshot' })
19817
- * ```
19818
- *
19819
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19820
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19821
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19822
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19823
- *
19824
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19825
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19826
- *
19827
- * To print the views embedded in their page context, set `content` to `screenshot`.
19828
- */
19829
- print(options?: OpenFin.WindowPrintOptions): Promise<void>;
19830
- }
19831
-
19832
- /**
19833
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19834
- * @interface
19835
- */
19836
- declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19837
- type: 'window-alert-requested';
19838
- };
19839
-
19840
- /**
19841
- * Returned from getBounds call. bottom and right are never used for setting.
19842
- * @interface
19843
- */
19844
- declare type WindowBounds = Bounds & {
19845
- bottom: number;
19846
- right: number;
19847
- };
19848
-
19849
- /**
19850
- * @deprecated Renamed to {@link ClosedEvent}.
19851
- */
19852
- declare type WindowClosedEvent = ClosedEvent_2;
19853
-
19854
- /**
19855
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19856
- */
19857
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19858
-
19859
- /**
19860
- * @deprecated Renamed to {@link ClosingEvent}.
19861
- */
19862
- declare type WindowClosingEvent = ClosingEvent;
19863
-
19864
- /**
19865
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19866
- *
19867
- * @interface
19868
- */
19869
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19870
- /**
19871
- * Behavior to use when opening matched content.
19872
- */
19873
- behavior: 'window';
19874
- /**
19875
- * Options for newly-created window.
19876
- */
19877
- options?: Partial<WindowOptions>;
19878
- };
19879
-
19880
- /**
19881
- * Generated when a child window is created.
19882
- * @interface
19883
- */
19884
- declare type WindowCreatedEvent = BaseEvent_3 & {
19885
- type: 'window-created';
19886
- };
19887
-
19888
- /**
19889
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19890
- *
19891
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19892
- * (defaults to `"about:blank"` when omitted).
19893
- * @interface
19894
- */
19895
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19896
- name: string;
19897
- };
19898
-
19899
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19900
-
19901
- /**
19902
- * @interface
19903
- */
19904
- declare type WindowDetail = {
19905
- /**
19906
- * The bottom-most coordinate of the window.
19907
- */
19908
- bottom: number;
19909
- /**
19910
- * The height of the window.
19911
- */
19912
- height: number;
19913
- isShowing: boolean;
19914
- /**
19915
- * The left-most coordinate of the window.
19916
- */
19917
- left: number;
19918
- /**
19919
- * The name of the window.
19920
- */
19921
- name: string;
19922
- /**
19923
- * The right-most coordinate of the window.
19924
- */
19925
- right: number;
19926
- state: string;
19927
- /**
19928
- * The top-most coordinate of the window.
19929
- */
19930
- top: number;
19931
- /**
19932
- * The width of the window.
19933
- */
19934
- width: number;
19935
- };
19936
-
19937
- /**
19938
- * Generated when a child window ends loading.
19939
- * @interface
19940
- */
19941
- declare type WindowEndLoadEvent = BaseEvent_3 & {
19942
- type: 'window-end-load';
19943
- };
19944
-
19945
- /**
19946
- * @deprecated, Renamed to {@link Event}.
19947
- */
19948
- declare type WindowEvent = Event_6;
19949
-
19950
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19951
-
19952
- declare namespace WindowEvents {
19953
- export {
19954
- BaseEvent_5 as BaseEvent,
19955
- BaseWindowEvent,
19956
- ViewAttachedEvent,
19957
- ViewDetachedEvent,
19958
- WindowViewEvent,
19959
- AlertRequestedEvent,
19960
- AuthRequestedEvent,
19961
- EndLoadEvent,
19962
- WillRedirectEvent,
19963
- ReloadedEvent,
19964
- OptionsChangedEvent,
19965
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19966
- ExternalProcessExitedEvent,
19967
- ExternalProcessStartedEvent,
19968
- HiddenEvent_2 as HiddenEvent,
19969
- WindowHiddenEvent,
19970
- PreloadScriptInfoRunning,
19971
- PreloadScriptInfo,
19972
- PreloadScriptsStateChangeEvent,
19973
- UserBoundsChangeEvent,
19974
- BoundsChangeEvent,
19975
- WillMoveOrResizeEvent,
19976
- PerformanceReportEvent,
19977
- InputEvent_2 as InputEvent,
19978
- LayoutInitializedEvent,
19979
- LayoutReadyEvent,
19980
- BeginUserBoundsChangingEvent,
19981
- BoundsChangedEvent,
19982
- BoundsChangingEvent,
19983
- CloseRequestedEvent,
19984
- WindowCloseRequestedEvent,
19985
- ContextChangedEvent,
19986
- ClosedEvent_2 as ClosedEvent,
19987
- WindowClosedEvent,
19988
- ClosingEvent,
19989
- WindowClosingEvent,
19990
- DisabledMovementBoundsChangedEvent,
19991
- DisabledMovementBoundsChangingEvent,
19992
- EmbeddedEvent,
19993
- EndUserBoundsChangingEvent,
19994
- HotkeyEvent_2 as HotkeyEvent,
19995
- WindowHotkeyEvent,
19996
- InitializedEvent_2 as InitializedEvent,
19997
- WindowInitializedEvent,
19998
- MaximizedEvent,
19999
- MinimizedEvent,
20000
- PreloadScriptsStateChangedEvent,
20001
- PreloadScriptsStateChangingEvent,
20002
- RestoredEvent,
20003
- WindowRestoredEvent,
20004
- ShowRequestedEvent,
20005
- WindowShowRequestedEvent,
20006
- ShownEvent_2 as ShownEvent,
20007
- WindowShownEvent,
20008
- UserMovementEnabledEvent,
20009
- UserMovementDisabledEvent,
20010
- WillMoveEvent,
20011
- WillResizeEvent,
20012
- NonPropagatedWindowEvent,
20013
- ShowAllDownloadsEvent,
20014
- DownloadShelfVisibilityChangedEvent,
20015
- WindowSourcedEvent,
20016
- WillPropagateWindowEvent,
20017
- Event_6 as Event,
20018
- WindowEvent,
20019
- EventType_2 as EventType,
20020
- WindowEventType,
20021
- PropagatedEvent_3 as PropagatedEvent,
20022
- PropagatedWindowEvent,
20023
- PropagatedWindowEventType,
20024
- Payload_3 as Payload,
20025
- ByType_2 as ByType
20026
- }
20027
- }
20028
-
20029
- /**
20030
- * @deprecated Renamed to {@link EventType}.
20031
- */
20032
- declare type WindowEventType = WindowEvent['type'];
20033
-
20034
- /**
20035
- * @deprecated Renamed to {@link HiddenEvent}.
20036
- */
20037
- declare type WindowHiddenEvent = HiddenEvent_2;
20038
-
20039
- /**
20040
- * @deprecated Renamed to {@link HotkeyEvent}.
20041
- */
20042
- declare type WindowHotkeyEvent = HotkeyEvent_2;
20043
-
20044
- /**
20045
- * @interface
20046
- */
20047
- declare type WindowInfo = {
20048
- canNavigateBack: boolean;
20049
- canNavigateForward: boolean;
20050
- preloadScripts: Array<any>;
20051
- title: string;
20052
- url: string;
20053
- };
20054
-
20055
- /**
20056
- * @deprecated Renamed to {@link InitializedEvent}.
20057
- */
20058
- declare type WindowInitializedEvent = InitializedEvent_2;
20059
-
20060
- /**
20061
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
20062
- */
20063
- declare class _WindowModule extends Base {
20064
- /**
20065
- * Asynchronously returns a Window object that represents an existing window.
20066
- *
20067
- * @example
20068
- * ```js
20069
- * async function createWin() {
20070
- * const app = await fin.Application.start({
20071
- * name: 'myApp',
20072
- * uuid: 'app-1',
20073
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
20074
- * autoShow: true
20075
- * });
20076
- * return await app.getWindow();
20077
- * }
20078
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
20079
- * .then(win => console.log('wrapped window'))
20080
- * .catch(err => console.log(err));
20081
- * ```
20082
- */
20083
- wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
20084
- /**
20085
- * Synchronously returns a Window object that represents an existing window.
20086
- *
20087
- * @example
20088
- * ```js
20089
- * async function createWin() {
20090
- * const app = await fin.Application.start({
20091
- * name: 'myApp',
20092
- * uuid: 'app-1',
20093
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
20094
- * autoShow: true
20095
- * });
20096
- * return await app.getWindow();
20097
- * }
20098
- * await createWin();
20099
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
20100
- * ```
20101
- */
20102
- wrapSync(identity: OpenFin.Identity): OpenFin.Window;
20103
- /**
20104
- * Creates a new Window.
20105
- * @param options - Window creation options
20106
- *
20107
- * @example
20108
- * ```js
20109
- * async function createWindow() {
20110
- * const winOption = {
20111
- * name:'child',
20112
- * defaultWidth: 300,
20113
- * defaultHeight: 300,
20114
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
20115
- * frame: true,
20116
- * autoShow: true
20117
- * };
20118
- * return await fin.Window.create(winOption);
20119
- * }
20120
- *
20121
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
20122
- * ```
20123
- */
20124
- create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
20125
- /**
20126
- * Asynchronously returns a Window object that represents the current window
20127
- *
20128
- * @example
20129
- * ```js
20130
- * fin.Window.getCurrent()
20131
- * .then(wnd => console.log('current window'))
20132
- * .catch(err => console.log(err));
20133
- *
20134
- * ```
20135
- */
20136
- getCurrent(): Promise<OpenFin.Window>;
20137
- /**
20138
- * Synchronously returns a Window object that represents the current window
20139
- *
20140
- * @example
20141
- * ```js
20142
- * const wnd = fin.Window.getCurrentSync();
20143
- * const info = await wnd.getInfo();
20144
- * console.log(info);
20145
- *
20146
- * ```
20147
- */
20148
- getCurrentSync(): OpenFin.Window;
20149
- }
20150
-
20151
- /**
20152
- * Generated when a child window is not responding.
20153
- * @interface
20154
- */
20155
- declare type WindowNotRespondingEvent = BaseEvent_3 & {
20156
- type: 'window-not-responding';
20157
- };
20158
-
20159
- /**
20160
- * @interface
20161
- */
20162
- declare type WindowOptionDiff = {
20163
- [key in keyof WindowOptions]: {
20164
- oldVal: WindowOptions[key];
20165
- newVal: WindowOptions[key];
20166
- };
20167
- };
20168
-
20169
- /**
20170
- * @interface
20171
- */
20172
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
20173
-
20174
- declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
20175
-
20176
- /**
20177
- * @deprecated Renamed to {@link OptionsChangedEvent}.
20178
- */
20179
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
20180
-
20181
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
20182
-
20183
- /**
20184
- * Generated when a child window is responding.
20185
- * @interface
20186
- */
20187
- declare type WindowRespondingEvent = BaseEvent_3 & {
20188
- type: 'window-responding';
20189
- };
20190
-
20191
- /**
20192
- * @deprecated Renamed to {@link RestoredEvent}.
20193
- */
20194
- declare type WindowRestoredEvent = RestoredEvent;
20195
-
20196
- /**
20197
- * @deprecated Renamed to {@link ShownEvent}.
20198
- */
20199
- declare type WindowShownEvent = ShownEvent_2;
20200
-
20201
- /**
20202
- * @deprecated Renamed to {@link ShowRequestedEvent}.
20203
- */
20204
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
20205
-
20206
- /**
20207
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
20208
- * from {@link OpenFin.ViewEvents}.
20209
- */
20210
- 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;
20211
-
20212
- /**
20213
- * Generated when a child window starts loading.
20214
- * @interface
20215
- */
20216
- declare type WindowStartLoadEvent = BaseEvent_3 & {
20217
- type: 'window-start-load';
20218
- };
20219
-
20220
- /**
20221
- * Visibility state of a window.
20222
- */
20223
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
20224
-
20225
- /**
20226
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
20227
- * to the `Application` level, with the name pattern `window-view-eventname`.
20228
- */
20229
- declare type WindowViewEvent = {
20230
- viewIdentity: OpenFin.Identity;
20231
- } & (ViewAttachedEvent | ViewDetachedEvent);
20232
-
20233
- /**
20234
- * @interface
20235
- */
20236
- declare type WindowViewsPrintOptions = {
20237
- content: 'views';
20238
- includeSelf?: boolean;
20239
- };
20240
-
20241
- declare type Wire = EventEmitter & {
20242
- connect(messageReciever: MessageReceiver): Promise<any>;
20243
- connectSync(): any;
20244
- send(data: any): Promise<any>;
20245
- shutdown(): Promise<void>;
20246
- getPort(): string;
20247
- };
20248
-
20249
- declare type WireConstructor = {
20250
- new (onmessage: (data: any) => void): Wire;
20251
- };
20252
-
20253
- /**
20254
- * @internal
20255
- */
20256
- declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
20257
-
20258
- declare interface WithInterop {
20259
- interop: InteropClient;
20260
- }
20261
-
20262
- /**
20263
- * @internal
20264
- */
20265
- declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
20266
-
20267
- declare type WithPositioningOptions<T extends {} = {}> = T & {
20268
- positioningOptions?: OpenFin.PositioningOptions;
20269
- };
20270
-
20271
- /**
20272
- * @internal
20273
- * @interface
20274
- */
20275
- declare type WorkspacePlatformOptions = {
20276
- /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
20277
- [key: string]: any;
20278
- };
20279
-
20280
- /**
20281
- * A generic request to write any supported data to the clipboard.
20282
- * @interface
20283
- */
20284
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
20285
- /**
20286
- * Data to be written
20287
- */
20288
- data: {
20289
- text?: string;
20290
- html?: string;
20291
- rtf?: string;
20292
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
20293
- };
20294
-
20295
- /**
20296
- * @deprecated - instead use WriteAnyClipboardRequest
20297
- *
20298
- * A generic request to write any supported data to the clipboard.
20299
- *
20300
- * @interface
20301
- */
20302
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
20303
-
20304
- /**
20305
- * A request to write data to the clipboard.
20306
- * @interface
20307
- */
20308
- declare type WriteClipboardRequest = BaseClipboardRequest & {
20309
- /**
20310
- * Data to write to the clipboard.
20311
- */
20312
- data: string;
20313
- };
20314
-
20315
- /**
20316
- * @interface
20317
- */
20318
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
20319
- /**
20320
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
20321
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
20322
- * Using other image/<format> DataURLs will throw an Error.
20323
- */
20324
- image: string;
20325
- };
20326
-
20327
- /**
20328
- * @deprecated - instead use OpenFin.WriteClipboardRequest
20329
- *
20330
- * A request to write data to the clipboard.
20331
- *
20332
- * @interface
20333
- */
20334
- declare type WriteRequestType = WriteClipboardRequest;
20335
-
20336
- export { }
18577
+ * Dispatch a result to the caller of `showPopupWindow`.
18578
+ *
18579
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18580
+ * @param data Serializable data to send to the caller window.
18581
+ *
18582
+ * @example
18583
+ * ```js
18584
+ * await fin.me.dispatchPopupResult({
18585
+ * foo: 'bar'
18586
+ * });
18587
+ * ```
18588
+ */
18589
+ dispatchPopupResult(data: any): Promise<void>;
18590
+ /**
18591
+ * Prints the contents of the window.
18592
+ *
18593
+ * @param options Configuration for the print task.
18594
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18595
+ * and the default settings for printing.
18596
+ *
18597
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18598
+ *
18599
+ * @example
18600
+ * ```js
18601
+ * const win = fin.Window.getCurrentSync();
18602
+ *
18603
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18604
+ * console.log('print call has been sent to the system');
18605
+ * });
18606
+ * ```
18607
+ *
18608
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18609
+ * use the `content` option:
18610
+ *
18611
+ * ```js
18612
+ * const win = fin.Window.getCurrentSync();
18613
+ *
18614
+ * // Print embedded views
18615
+ * win.print({ content: 'views' });
18616
+ *
18617
+ * // Print screenshot of current window
18618
+ * win.print({ content: 'screenshot' })
18619
+ * ```
18620
+ *
18621
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18622
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18623
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18624
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18625
+ *
18626
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18627
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18628
+ *
18629
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18630
+ */
18631
+ print(options?: OpenFin.WindowPrintOptions): Promise<void>;
18632
+ }
18633
+
18634
+ /**
18635
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18636
+ * @interface
18637
+ */
18638
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18639
+ type: 'window-alert-requested';
18640
+ };
18641
+
18642
+ /**
18643
+ * Returned from getBounds call. bottom and right are never used for setting.
18644
+ * @interface
18645
+ */
18646
+ declare type WindowBounds = Bounds & {
18647
+ bottom: number;
18648
+ right: number;
18649
+ };
18650
+
18651
+ /**
18652
+ * @deprecated Renamed to {@link ClosedEvent}.
18653
+ */
18654
+ declare type WindowClosedEvent = ClosedEvent_2;
18655
+
18656
+ /**
18657
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18658
+ */
18659
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18660
+
18661
+ /**
18662
+ * @deprecated Renamed to {@link ClosingEvent}.
18663
+ */
18664
+ declare type WindowClosingEvent = ClosingEvent;
18665
+
18666
+ /**
18667
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18668
+ *
18669
+ * @interface
18670
+ */
18671
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18672
+ /**
18673
+ * Behavior to use when opening matched content.
18674
+ */
18675
+ behavior: 'window';
18676
+ /**
18677
+ * Options for newly-created window.
18678
+ */
18679
+ options?: Partial<WindowOptions>;
18680
+ };
18681
+
18682
+ /**
18683
+ * Generated when a child window is created.
18684
+ * @interface
18685
+ */
18686
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18687
+ type: 'window-created';
18688
+ };
18689
+
18690
+ /**
18691
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18692
+ *
18693
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18694
+ * (defaults to `"about:blank"` when omitted).
18695
+ * @interface
18696
+ */
18697
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18698
+ name: string;
18699
+ };
18700
+
18701
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18702
+
18703
+ /**
18704
+ * @interface
18705
+ */
18706
+ declare type WindowDetail = {
18707
+ /**
18708
+ * The bottom-most coordinate of the window.
18709
+ */
18710
+ bottom: number;
18711
+ /**
18712
+ * The height of the window.
18713
+ */
18714
+ height: number;
18715
+ isShowing: boolean;
18716
+ /**
18717
+ * The left-most coordinate of the window.
18718
+ */
18719
+ left: number;
18720
+ /**
18721
+ * The name of the window.
18722
+ */
18723
+ name: string;
18724
+ /**
18725
+ * The right-most coordinate of the window.
18726
+ */
18727
+ right: number;
18728
+ state: string;
18729
+ /**
18730
+ * The top-most coordinate of the window.
18731
+ */
18732
+ top: number;
18733
+ /**
18734
+ * The width of the window.
18735
+ */
18736
+ width: number;
18737
+ };
18738
+
18739
+ /**
18740
+ * Generated when a child window ends loading.
18741
+ * @interface
18742
+ */
18743
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18744
+ type: 'window-end-load';
18745
+ };
18746
+
18747
+ /**
18748
+ * @deprecated, Renamed to {@link Event}.
18749
+ */
18750
+ declare type WindowEvent = Event_6;
18751
+
18752
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18753
+
18754
+ declare namespace WindowEvents {
18755
+ export {
18756
+ BaseEvent_5 as BaseEvent,
18757
+ BaseWindowEvent,
18758
+ ViewAttachedEvent,
18759
+ ViewDetachedEvent,
18760
+ WindowViewEvent,
18761
+ AlertRequestedEvent,
18762
+ AuthRequestedEvent,
18763
+ EndLoadEvent,
18764
+ WillRedirectEvent,
18765
+ ReloadedEvent,
18766
+ OptionsChangedEvent,
18767
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18768
+ ExternalProcessExitedEvent,
18769
+ ExternalProcessStartedEvent,
18770
+ HiddenEvent_2 as HiddenEvent,
18771
+ WindowHiddenEvent,
18772
+ PreloadScriptInfoRunning,
18773
+ PreloadScriptInfo,
18774
+ PreloadScriptsStateChangeEvent,
18775
+ UserBoundsChangeEvent,
18776
+ BoundsChangeEvent,
18777
+ WillMoveOrResizeEvent,
18778
+ PerformanceReportEvent,
18779
+ InputEvent_2 as InputEvent,
18780
+ LayoutInitializedEvent,
18781
+ LayoutReadyEvent,
18782
+ BeginUserBoundsChangingEvent,
18783
+ BoundsChangedEvent,
18784
+ BoundsChangingEvent,
18785
+ CloseRequestedEvent,
18786
+ WindowCloseRequestedEvent,
18787
+ ContextChangedEvent,
18788
+ ClosedEvent_2 as ClosedEvent,
18789
+ WindowClosedEvent,
18790
+ ClosingEvent,
18791
+ WindowClosingEvent,
18792
+ DisabledMovementBoundsChangedEvent,
18793
+ DisabledMovementBoundsChangingEvent,
18794
+ EmbeddedEvent,
18795
+ EndUserBoundsChangingEvent,
18796
+ HotkeyEvent_2 as HotkeyEvent,
18797
+ WindowHotkeyEvent,
18798
+ InitializedEvent_2 as InitializedEvent,
18799
+ WindowInitializedEvent,
18800
+ MaximizedEvent,
18801
+ MinimizedEvent,
18802
+ PreloadScriptsStateChangedEvent,
18803
+ PreloadScriptsStateChangingEvent,
18804
+ RestoredEvent,
18805
+ WindowRestoredEvent,
18806
+ ShowRequestedEvent,
18807
+ WindowShowRequestedEvent,
18808
+ ShownEvent_2 as ShownEvent,
18809
+ WindowShownEvent,
18810
+ UserMovementEnabledEvent,
18811
+ UserMovementDisabledEvent,
18812
+ WillMoveEvent,
18813
+ WillResizeEvent,
18814
+ NonPropagatedWindowEvent,
18815
+ ShowAllDownloadsEvent,
18816
+ DownloadShelfVisibilityChangedEvent,
18817
+ WindowSourcedEvent,
18818
+ WillPropagateWindowEvent,
18819
+ Event_6 as Event,
18820
+ WindowEvent,
18821
+ EventType_2 as EventType,
18822
+ WindowEventType,
18823
+ PropagatedEvent_3 as PropagatedEvent,
18824
+ PropagatedWindowEvent,
18825
+ PropagatedWindowEventType,
18826
+ Payload_3 as Payload,
18827
+ ByType_2 as ByType
18828
+ }
18829
+ }
18830
+
18831
+ /**
18832
+ * @deprecated Renamed to {@link EventType}.
18833
+ */
18834
+ declare type WindowEventType = WindowEvent['type'];
18835
+
18836
+ /**
18837
+ * @deprecated Renamed to {@link HiddenEvent}.
18838
+ */
18839
+ declare type WindowHiddenEvent = HiddenEvent_2;
18840
+
18841
+ /**
18842
+ * @deprecated Renamed to {@link HotkeyEvent}.
18843
+ */
18844
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18845
+
18846
+ /**
18847
+ * @interface
18848
+ */
18849
+ declare type WindowInfo = {
18850
+ canNavigateBack: boolean;
18851
+ canNavigateForward: boolean;
18852
+ preloadScripts: Array<any>;
18853
+ title: string;
18854
+ url: string;
18855
+ };
18856
+
18857
+ /**
18858
+ * @deprecated Renamed to {@link InitializedEvent}.
18859
+ */
18860
+ declare type WindowInitializedEvent = InitializedEvent_2;
18861
+
18862
+ /**
18863
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18864
+ */
18865
+ declare class _WindowModule extends Base {
18866
+ /**
18867
+ * Asynchronously returns a Window object that represents an existing window.
18868
+ *
18869
+ * @example
18870
+ * ```js
18871
+ * async function createWin() {
18872
+ * const app = await fin.Application.start({
18873
+ * name: 'myApp',
18874
+ * uuid: 'app-1',
18875
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18876
+ * autoShow: true
18877
+ * });
18878
+ * return await app.getWindow();
18879
+ * }
18880
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18881
+ * .then(win => console.log('wrapped window'))
18882
+ * .catch(err => console.log(err));
18883
+ * ```
18884
+ */
18885
+ wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18886
+ /**
18887
+ * Synchronously returns a Window object that represents an existing window.
18888
+ *
18889
+ * @example
18890
+ * ```js
18891
+ * async function createWin() {
18892
+ * const app = await fin.Application.start({
18893
+ * name: 'myApp',
18894
+ * uuid: 'app-1',
18895
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18896
+ * autoShow: true
18897
+ * });
18898
+ * return await app.getWindow();
18899
+ * }
18900
+ * await createWin();
18901
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18902
+ * ```
18903
+ */
18904
+ wrapSync(identity: OpenFin.Identity): OpenFin.Window;
18905
+ /**
18906
+ * Creates a new Window.
18907
+ * @param options - Window creation options
18908
+ *
18909
+ * @example
18910
+ * ```js
18911
+ * async function createWindow() {
18912
+ * const winOption = {
18913
+ * name:'child',
18914
+ * defaultWidth: 300,
18915
+ * defaultHeight: 300,
18916
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18917
+ * frame: true,
18918
+ * autoShow: true
18919
+ * };
18920
+ * return await fin.Window.create(winOption);
18921
+ * }
18922
+ *
18923
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18924
+ * ```
18925
+ */
18926
+ create(options: OpenFin.WindowCreationOptions): Promise<OpenFin.Window>;
18927
+ /**
18928
+ * Asynchronously returns a Window object that represents the current window
18929
+ *
18930
+ * @example
18931
+ * ```js
18932
+ * fin.Window.getCurrent()
18933
+ * .then(wnd => console.log('current window'))
18934
+ * .catch(err => console.log(err));
18935
+ *
18936
+ * ```
18937
+ */
18938
+ getCurrent(): Promise<OpenFin.Window>;
18939
+ /**
18940
+ * Synchronously returns a Window object that represents the current window
18941
+ *
18942
+ * @example
18943
+ * ```js
18944
+ * const wnd = fin.Window.getCurrentSync();
18945
+ * const info = await wnd.getInfo();
18946
+ * console.log(info);
18947
+ *
18948
+ * ```
18949
+ */
18950
+ getCurrentSync(): OpenFin.Window;
18951
+ }
18952
+
18953
+ /**
18954
+ * Generated when a child window is not responding.
18955
+ * @interface
18956
+ */
18957
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18958
+ type: 'window-not-responding';
18959
+ };
18960
+
18961
+ /**
18962
+ * @interface
18963
+ */
18964
+ declare type WindowOptionDiff = {
18965
+ [key in keyof WindowOptions]: {
18966
+ oldVal: WindowOptions[key];
18967
+ newVal: WindowOptions[key];
18968
+ };
18969
+ };
18970
+
18971
+ /**
18972
+ * @interface
18973
+ */
18974
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18975
+
18976
+ declare type WindowOptionsChangedEvent = OpenFin.WindowEvents.WindowOptionsChangedEvent;
18977
+
18978
+ /**
18979
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18980
+ */
18981
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18982
+
18983
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18984
+
18985
+ /**
18986
+ * Generated when a child window is responding.
18987
+ * @interface
18988
+ */
18989
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18990
+ type: 'window-responding';
18991
+ };
18992
+
18993
+ /**
18994
+ * @deprecated Renamed to {@link RestoredEvent}.
18995
+ */
18996
+ declare type WindowRestoredEvent = RestoredEvent;
18997
+
18998
+ /**
18999
+ * @deprecated Renamed to {@link ShownEvent}.
19000
+ */
19001
+ declare type WindowShownEvent = ShownEvent_2;
19002
+
19003
+ /**
19004
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
19005
+ */
19006
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
19007
+
19008
+ /**
19009
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19010
+ * from {@link OpenFin.ViewEvents}.
19011
+ */
19012
+ 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;
19013
+
19014
+ /**
19015
+ * Generated when a child window starts loading.
19016
+ * @interface
19017
+ */
19018
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
19019
+ type: 'window-start-load';
19020
+ };
19021
+
19022
+ /**
19023
+ * Visibility state of a window.
19024
+ */
19025
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
19026
+
19027
+ /**
19028
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19029
+ * to the `Application` level, with the name pattern `window-view-eventname`.
19030
+ */
19031
+ declare type WindowViewEvent = {
19032
+ viewIdentity: OpenFin.Identity;
19033
+ } & (ViewAttachedEvent | ViewDetachedEvent);
19034
+
19035
+ /**
19036
+ * @interface
19037
+ */
19038
+ declare type WindowViewsPrintOptions = {
19039
+ content: 'views';
19040
+ includeSelf?: boolean;
19041
+ };
19042
+
19043
+ declare type Wire = EventEmitter & {
19044
+ connect(messageReciever: MessageReceiver): Promise<any>;
19045
+ connectSync(): any;
19046
+ send(data: any): Promise<any>;
19047
+ shutdown(): Promise<void>;
19048
+ getPort(): string;
19049
+ };
19050
+
19051
+ declare type WireConstructor = {
19052
+ new (onmessage: (data: any) => void): Wire;
19053
+ };
19054
+
19055
+ /**
19056
+ * @internal
19057
+ */
19058
+ declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
19059
+
19060
+ declare interface WithInterop {
19061
+ interop: InteropClient;
19062
+ }
19063
+
19064
+ /**
19065
+ * @internal
19066
+ */
19067
+ declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
19068
+
19069
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
19070
+ positioningOptions?: OpenFin.PositioningOptions;
19071
+ };
19072
+
19073
+ /**
19074
+ * @internal
19075
+ * @interface
19076
+ */
19077
+ declare type WorkspacePlatformOptions = {
19078
+ /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
19079
+ [key: string]: any;
19080
+ };
19081
+
19082
+ /**
19083
+ * A generic request to write any supported data to the clipboard.
19084
+ * @interface
19085
+ */
19086
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19087
+ /**
19088
+ * Data to be written
19089
+ */
19090
+ data: {
19091
+ text?: string;
19092
+ html?: string;
19093
+ rtf?: string;
19094
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19095
+ };
19096
+
19097
+ /**
19098
+ * @deprecated - instead use WriteAnyClipboardRequest
19099
+ *
19100
+ * A generic request to write any supported data to the clipboard.
19101
+ *
19102
+ * @interface
19103
+ */
19104
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19105
+
19106
+ /**
19107
+ * A request to write data to the clipboard.
19108
+ * @interface
19109
+ */
19110
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
19111
+ /**
19112
+ * Data to write to the clipboard.
19113
+ */
19114
+ data: string;
19115
+ };
19116
+
19117
+ /**
19118
+ * @interface
19119
+ */
19120
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19121
+ /**
19122
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
19123
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19124
+ * Using other image/<format> DataURLs will throw an Error.
19125
+ */
19126
+ image: string;
19127
+ };
19128
+
19129
+ /**
19130
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
19131
+ *
19132
+ * A request to write data to the clipboard.
19133
+ *
19134
+ * @interface
19135
+ */
19136
+ declare type WriteRequestType = WriteClipboardRequest;
19137
+
19138
+ export { }