@openfin/core 35.78.15 → 35.78.17

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.
package/out/mock.d.ts CHANGED
@@ -195,100 +195,6 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
195
195
  */
196
196
  constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity);
197
197
  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
198
  /**
293
199
  * Determines if the application is currently running.
294
200
  *
@@ -3150,20 +3056,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3150
3056
  connectionUrl: string;
3151
3057
  };
3152
3058
 
3153
- /**
3154
- * @PORTED
3155
- * WriteRequestType interface
3156
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3157
- * @property { string } data Data to be written
3158
- * @property { string } [type] Clipboard Type
3159
- */
3160
- /**
3161
- * @PORTED
3162
- * OpenFin.WriteAnyClipboardRequest interface
3163
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3164
- * @property { string } data Data to be written
3165
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3166
- */
3167
3059
  /**
3168
3060
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3169
3061
  *
@@ -5396,83 +5288,6 @@ declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicat
5396
5288
  * @internal
5397
5289
  */
5398
5290
  constructor(wire: Transport, identity: OpenFin_2.ApplicationIdentity);
5399
- /**
5400
- * Adds a listener to the end of the listeners array for the specified event.
5401
- * @param eventType - The type of the event.
5402
- * @param listener - Called whenever an event of the specified type occurs.
5403
- * @param options - Option to support event timestamps.
5404
- *
5405
- * @function addListener
5406
- * @memberof ExternalApplication
5407
- * @instance
5408
- * @tutorial ExternalApplication.EventEmitter
5409
- */
5410
- /**
5411
- * Adds a listener to the end of the listeners array for the specified event.
5412
- * @param eventType - The type of the event.
5413
- * @param listener - Called whenever an event of the specified type occurs.
5414
- * @param options - Option to support event timestamps.
5415
- *
5416
- * @function on
5417
- * @memberof ExternalApplication
5418
- * @instance
5419
- * @tutorial ExternalApplication.EventEmitter
5420
- */
5421
- /**
5422
- * 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.
5423
- * @param eventType - The type of the event.
5424
- * @param listener - The callback function.
5425
- * @param options - Option to support event timestamps.
5426
- *
5427
- * @function once
5428
- * @memberof ExternalApplication
5429
- * @instance
5430
- * @tutorial ExternalApplication.EventEmitter
5431
- */
5432
- /**
5433
- * Adds a listener to the beginning of the listeners array for the specified event.
5434
- * @param eventType - The type of the event.
5435
- * @param listener - The callback function.
5436
- * @param options - Option to support event timestamps.
5437
- *
5438
- * @function prependListener
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
- * The listener is added to the beginning of the listeners array.
5446
- * @param eventType - The type of the event.
5447
- * @param listener - The callback function.
5448
- * @param options - Option to support event timestamps.
5449
- *
5450
- * @function prependOnceListener
5451
- * @memberof ExternalApplication
5452
- * @instance
5453
- * @tutorial ExternalApplication.EventEmitter
5454
- */
5455
- /**
5456
- * Remove a listener from the listener array for the specified event.
5457
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5458
- * @param eventType - The type of the event.
5459
- * @param listener - The callback function.
5460
- * @param options - Option to support event timestamps.
5461
- *
5462
- * @function removeListener
5463
- * @memberof ExternalApplication
5464
- * @instance
5465
- * @tutorial ExternalApplication.EventEmitter
5466
- */
5467
- /**
5468
- * Removes all listeners, or those of the specified event.
5469
- * @param eventType - The type of the event.
5470
- *
5471
- * @function removeAllListeners
5472
- * @memberof ExternalApplication
5473
- * @instance
5474
- * @tutorial ExternalApplication.EventEmitter
5475
- */
5476
5291
  /**
5477
5292
  * Retrieves information about the external application.
5478
5293
  *
@@ -5891,83 +5706,6 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5891
5706
  * @internal
5892
5707
  */
5893
5708
  constructor(wire: Transport, identity: OpenFin_2.Identity);
5894
- /**
5895
- * Adds the listener function to the end of the listeners array for the specified event type.
5896
- * @param eventType - The type of the event.
5897
- * @param listener - Called whenever an event of the specified type occurs.
5898
- * @param options - Option to support event timestamps.
5899
- *
5900
- * @function addListener
5901
- * @memberof Frame
5902
- * @instance
5903
- * @tutorial Frame.EventEmitter
5904
- */
5905
- /**
5906
- * Adds a listener to the end of the listeners array for the specified event.
5907
- * @param eventType - The type of the event.
5908
- * @param listener - Called whenever an event of the specified type occurs.
5909
- * @param options - Option to support event timestamps.
5910
- *
5911
- * @function on
5912
- * @memberof Frame
5913
- * @instance
5914
- * @tutorial Frame.EventEmitter
5915
- */
5916
- /**
5917
- * 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.
5918
- * @param eventType - The type of the event.
5919
- * @param listener - The callback function.
5920
- * @param options - Option to support event timestamps.
5921
- *
5922
- * @function once
5923
- * @memberof Frame
5924
- * @instance
5925
- * @tutorial Frame.EventEmitter
5926
- */
5927
- /**
5928
- * Adds a listener to the beginning of the listeners array for the specified event.
5929
- * @param eventType - The type of the event.
5930
- * @param listener - The callback function.
5931
- * @param options - Option to support event timestamps.
5932
- *
5933
- * @function prependListener
5934
- * @memberof Frame
5935
- * @instance
5936
- * @tutorial Frame.EventEmitter
5937
- */
5938
- /**
5939
- * 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.
5940
- * The listener is added to the beginning of the listeners array.
5941
- * @param eventType - The type of the event.
5942
- * @param listener - The callback function.
5943
- * @param options - Option to support event timestamps.
5944
- *
5945
- * @function prependOnceListener
5946
- * @memberof Frame
5947
- * @instance
5948
- * @tutorial Frame.EventEmitter
5949
- */
5950
- /**
5951
- * Remove a listener from the listener array for the specified event.
5952
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5953
- * @param eventType - The type of the event.
5954
- * @param listener - The callback function.
5955
- * @param options - Option to support event timestamps.
5956
- *
5957
- * @function removeListener
5958
- * @memberof Frame
5959
- * @instance
5960
- * @tutorial Frame.EventEmitter
5961
- */
5962
- /**
5963
- * Removes all listeners, or those of the specified event.
5964
- * @param eventType - The type of the event.
5965
- *
5966
- * @function removeAllListeners
5967
- * @memberof Frame
5968
- * @instance
5969
- * @tutorial Frame.EventEmitter
5970
- */
5971
5709
  /**
5972
5710
  * Returns a frame info object for the represented frame.
5973
5711
  *
@@ -7251,56 +6989,6 @@ declare class InteropBroker extends Base {
7251
6989
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7252
6990
  new (): InteropBroker;
7253
6991
  };
7254
- /**
7255
- * @REMOVED
7256
- * SetContextOptions interface
7257
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
7258
- * @property { Context } {context} - New context to set.
7259
- */
7260
- /**
7261
- * @REMOVED
7262
- * GetContextOptions interface
7263
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
7264
- * @property { string } [contextType] - Context Type
7265
- */
7266
- /**
7267
- * @REMOVED
7268
- * JoinContextGroupOptions interface
7269
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
7270
- * @property { string } contextGroupId - Id of the context group.
7271
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
7272
- */
7273
- /**
7274
- * @REMOVED
7275
- * AddClientToContextGroupOptions interface
7276
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
7277
- * @property { string } contextGroupId - Name of the context group.
7278
- */
7279
- /**
7280
- * @REMOVED
7281
- * RemoveFromContextGroupOptions interface
7282
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
7283
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
7284
- */
7285
- /**
7286
- * @REMOVED
7287
- * GetInfoForContextGroupOptions interface
7288
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
7289
- * @property { string } contextGroupId - Name of the context group to get info for.
7290
- */
7291
- /**
7292
- * @REMOVED
7293
- * GetAllClientsInContextGroupOptions interface
7294
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
7295
- * @property { string } contextGroupId - Name of the context group to get info for.
7296
- */
7297
- /**
7298
- * @PORTED
7299
- * InfoForIntentOptions interface
7300
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
7301
- * @property { string } name Name of the intent to get info for.
7302
- * @property { Context } [context] Optional context.
7303
- */
7304
6992
  /**
7305
6993
  * Sets a context for the context group of the incoming current entity.
7306
6994
  * @param setContextOptions - New context to set.
@@ -7800,95 +7488,6 @@ declare type InteropBrokerOptions = {
7800
7488
  logging?: InteropLoggingOptions;
7801
7489
  };
7802
7490
 
7803
- /**
7804
- * @PORTED
7805
- * @typedef { object } Intent
7806
- * @summary The combination of an action and a context that is passed to an application for resolution.
7807
- * @property { string } name Name of the intent.
7808
- * @property { Context } context Data associated with the intent
7809
- */
7810
- /**
7811
- * @REMOVED
7812
- * @typedef { object } Subscription
7813
- * @summary Object returned when subscribing a handler.
7814
- * @property { function } unsubscribe Function to unsubscribe the handler.
7815
- */
7816
- /**
7817
- * @typedef { function } ContextHandler
7818
- * @summary Subscription function for addContextHandler.
7819
- */
7820
- /**
7821
- * @typedef { function } IntentHandler
7822
- * @summary Subscription function for registerIntentHandler
7823
- */
7824
- /**
7825
- * @PORTED
7826
- * @typedef { object } ClientIdentity
7827
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7828
- * @property {string} uuid GUID of an application.
7829
- * @property {string} name Name of an entity in an application.
7830
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7831
- */
7832
- /**
7833
- * @PORTED
7834
- * @typedef { object } ContextGroupInfo
7835
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7836
- * @property {string} id Name of the context group
7837
- * @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.
7838
- */
7839
- /**
7840
- * @PORTED
7841
- * @typedef { object } DisplayMetadata
7842
- * @summary The display data for a Context Group.
7843
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7844
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7845
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7846
- */
7847
- /**
7848
- * @PORTED
7849
- * @typedef { object } Context
7850
- * @summary Data passed between entities and applications.
7851
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7852
- * @property {string} [name] User-readable name for the incoming context.
7853
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7854
- */
7855
- /**
7856
- * @REMOVED
7857
- * @typedef { object } ContextForIntent
7858
- * @summary Data passed between entities and applications, including an optional metadata.
7859
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7860
- * @property {string} [name] User-readable name for the incoming context.
7861
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7862
- * @property {any} [metadata]
7863
- */
7864
- /**
7865
- * @REMOVED
7866
- * @typedef { object } SessionContextGroup
7867
- * @summary An instance of a SessionContextGroup
7868
- * @property {string} id The SessionContextGroup's id.
7869
- * @property {setContext} setContext Sets a context of a certain type
7870
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7871
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7872
- */
7873
- /**
7874
- * @typedef {function} setContext
7875
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7876
- * @param context The Context to be set.
7877
- *
7878
- */
7879
- /**
7880
- * @typedef {function} getCurrentContext
7881
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7882
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7883
- *
7884
- */
7885
- /**
7886
- * @typedef {function} addContextHandler
7887
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7888
- * @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.
7889
- * @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.
7890
- *
7891
- */
7892
7491
  /**
7893
7492
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7894
7493
  *
@@ -8327,13 +7926,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8327
7926
  */
8328
7927
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8329
7928
 
8330
- /**
8331
- * @PORTED
8332
- * @typedef { object } InteropConfig
8333
- * @summary Information relevant to the Interop Broker.
8334
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
8335
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
8336
- */
8337
7929
  /**
8338
7930
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8339
7931
  *
@@ -14070,83 +13662,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
14070
13662
  */
14071
13663
  constructor(wire: Transport);
14072
13664
  private sendExternalProcessRequest;
14073
- /**
14074
- * Adds a listener to the end of the listeners array for the specified event.
14075
- * @param eventType - The type of the event.
14076
- * @param listener - Called whenever an event of the specified type occurs.
14077
- * @param options - Option to support event timestamps.
14078
- *
14079
- * @function addListener
14080
- * @memberof System
14081
- * @instance
14082
- * @tutorial System.EventEmitter
14083
- */
14084
- /**
14085
- * Adds a listener to the end of the listeners array for the specified event.
14086
- * @param eventType - The type of the event.
14087
- * @param listener - Called whenever an event of the specified type occurs.
14088
- * @param options - Option to support event timestamps.
14089
- *
14090
- * @function on
14091
- * @memberof System
14092
- * @instance
14093
- * @tutorial System.EventEmitter
14094
- */
14095
- /**
14096
- * 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.
14097
- * @param eventType - The type of the event.
14098
- * @param listener - The callback function.
14099
- * @param options - Option to support event timestamps.
14100
- *
14101
- * @function once
14102
- * @memberof System
14103
- * @instance
14104
- * @tutorial System.EventEmitter
14105
- */
14106
- /**
14107
- * Adds a listener to the beginning of the listeners array for the specified event.
14108
- * @param eventType - The type of the event.
14109
- * @param listener - The callback function.
14110
- * @param options - Option to support event timestamps.
14111
- *
14112
- * @function prependListener
14113
- * @memberof System
14114
- * @instance
14115
- * @tutorial System.EventEmitter
14116
- */
14117
- /**
14118
- * 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.
14119
- * The listener is added to the beginning of the listeners array.
14120
- * @param eventType - The type of the event.
14121
- * @param listener - The callback function.
14122
- * @param options - Option to support event timestamps.
14123
- *
14124
- * @function prependOnceListener
14125
- * @memberof System
14126
- * @instance
14127
- * @tutorial System.EventEmitter
14128
- */
14129
- /**
14130
- * Remove a listener from the listener array for the specified event.
14131
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
14132
- * @param eventType - The type of the event.
14133
- * @param listener - The callback function.
14134
- * @param options - Option to support event timestamps.
14135
- *
14136
- * @function removeListener
14137
- * @memberof System
14138
- * @instance
14139
- * @tutorial System.EventEmitter
14140
- */
14141
- /**
14142
- * Removes all listeners, or those of the specified event.
14143
- * @param eventType - The type of the event.
14144
- *
14145
- * @function removeAllListeners
14146
- * @memberof System
14147
- * @instance
14148
- * @tutorial System.EventEmitter
14149
- */
14150
13665
  /**
14151
13666
  * Returns the version of the runtime. The version contains the major, minor,
14152
13667
  * build and revision numbers.
@@ -16181,169 +15696,6 @@ declare type VerboseWebPermission = {
16181
15696
 
16182
15697
  declare type View = OpenFin_2.View;
16183
15698
 
16184
- /**
16185
- * @PORTED
16186
- * @typedef {object} View~options
16187
- * @summary View creation options.
16188
- * @desc This is the options object required by {@link View.create View.create}.
16189
- *
16190
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
16191
- * (defaults to `"about:blank"` when omitted).
16192
- *
16193
- * @property {object} [experimental]
16194
- * Configurations for API injection.
16195
- *
16196
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
16197
- *
16198
- * @property {object} [accelerator]
16199
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
16200
- *
16201
- * @property {boolean} [accelerator.devtools=false]
16202
- * If `true`, enables the devtools keyboard shortcut:<br>
16203
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
16204
- *
16205
- * @property {boolean} [accelerator.reload=false]
16206
- * If `true`, enables the reload keyboard shortcuts:<br>
16207
- * `Ctrl` + `R` _(Windows)_<br>
16208
- * `F5` _(Windows)_<br>
16209
- * `Command` + `R` _(Mac)_
16210
- *
16211
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
16212
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
16213
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
16214
- * `Shift` + `F5` _(Windows)_<br>
16215
- * `Command` + `Shift` + `R` _(Mac)_
16216
- *
16217
- * @property {boolean} [accelerator.zoom=false]
16218
- * If `true`, enables the zoom keyboard shortcuts:<br>
16219
- * `Ctrl` + `+` _(Zoom In)_<br>
16220
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
16221
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
16222
- * `Ctrl` + `-` _(Zoom Out)_<br>
16223
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
16224
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
16225
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
16226
- * `Ctrl` + `0` _(Restore to 100%)_
16227
- *
16228
- * @property {object} [api]
16229
- * Configurations for API injection.
16230
- *
16231
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
16232
- *
16233
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
16234
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
16235
- *
16236
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
16237
- * Autoplay policy to apply to content in the window, can be
16238
- * `no-user-gesture-required`, `user-gesture-required`,
16239
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
16240
- *
16241
- * @property {object} [autoResize] AutoResize options
16242
- *
16243
- * @property {object} [bounds] initial bounds given relative to the window.
16244
- *
16245
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
16246
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
16247
- * (`document.body.style.backgroundColor`),
16248
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
16249
- * areas when growing a window. Setting
16250
- * this value to the anticipated content background color can help improve user experience.
16251
- * Default is white.
16252
- *
16253
- * @property {object} [contentNavigation]
16254
- * Restrict navigation to URLs that match an allowed pattern.
16255
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
16256
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
16257
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
16258
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
16259
- *
16260
- * @property {object} [contentRedirect]
16261
- * Restrict redirects to URLs that match an allowed pattern.
16262
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
16263
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
16264
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
16265
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
16266
- *
16267
- * @property {object} [contextMenuSettings] - _Updatable._
16268
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
16269
- * Configure the context menu when right-clicking on a view.
16270
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
16271
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
16272
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
16273
- *
16274
- * @property {object} [contextMenuOptions] - _Updatable._
16275
- * Configure the context menu when right-clicking on a view. Supported menu items:
16276
- * 'separator'
16277
- * 'cut'
16278
- * 'copy'
16279
- * 'copyImage',
16280
- * 'paste'
16281
- * 'spellCheck'
16282
- * 'inspect'
16283
- * 'reload'
16284
- * 'navigateForward'
16285
- * 'navigateBack'
16286
- * 'print'
16287
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
16288
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
16289
- *
16290
- * @property {any} [customData=""] - _Updatable._
16291
- * A field that the user can attach serializable data to be ferried around with the view options.
16292
- * _When omitted, the default value of this property is the empty string (`""`)._
16293
- *
16294
- * @property {any} [customContext=""] - _Updatable._
16295
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
16296
- * is called.
16297
- * When omitted, the default value of this property is the empty string (`""`).
16298
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
16299
- *
16300
- * @property {object[]} [hotkeys=[]] - _Updatable._
16301
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
16302
- * Within Platform, OpenFin also implements a set of pre-defined actions called
16303
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
16304
- * that can be assigned to a specific hotkey in the platform manifest.
16305
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
16306
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
16307
- *
16308
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
16309
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
16310
- * if the view isn't part of the new layout when running `Layout.replace`.
16311
- *
16312
- * @property {string} name
16313
- * The name of the view.
16314
- *
16315
- * @property {boolean} [detachOnClose=false] - _Updatable._
16316
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
16317
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
16318
- *
16319
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
16320
- * but the properties in the manifest will take precedence if there is any collision.
16321
- *
16322
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
16323
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
16324
- * from the parent application.
16325
- *
16326
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
16327
- *
16328
- * @property {string} [processAffinity=<application uuid>]
16329
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
16330
- *
16331
- * @property {boolean} [spellCheck=false]
16332
- * Enable spell check in input text fields for the view.
16333
- *
16334
- * @property {Identity} [target]
16335
- * The identity of the window this view should be attached to.
16336
- *
16337
- * @property {string} [url="about:blank"]
16338
- * The URL of the view.
16339
- *
16340
- * @property {string} [uuid=<application uuid>]
16341
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
16342
- * If omitted, defaults to the `uuid` of the application spawning the view.
16343
- * If given, must match the `uuid` of the application spawning the view.
16344
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
16345
- * really no need to provide it.
16346
- */
16347
15699
  /**
16348
15700
  * A View can be used to embed additional web content into a Window.
16349
15701
  * It is like a child window, except it is positioned relative to its owning window.
@@ -18173,476 +17525,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
18173
17525
  type: 'will-resize';
18174
17526
  };
18175
17527
 
18176
- /**
18177
- * @PORTED
18178
- * @typedef { object } Margins@typedef { object } Margins
18179
- * @property { string } [marginType]
18180
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
18181
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
18182
- *
18183
- * @property { number } [top] The top margin of the printed web page, in pixels.
18184
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
18185
- * @property { number } [left] The left margin of the printed web page, in pixels.
18186
- * @property { number } [right] The right margin of the printed web page, in pixels.
18187
- */
18188
- /**
18189
- * @PORTED
18190
- * @typedef { object } Dpi@typedef { object } Dpi
18191
- * @property { number } [horizontal] The horizontal dpi
18192
- * @property { number } [vertical] The vertical dpi
18193
- */
18194
- /**
18195
- * @PORTED
18196
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
18197
- * @property { boolean } [silent=false] Don't ask user for print settings.
18198
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
18199
- * @property { string } [deviceName=''] Set the printer device name to use.
18200
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
18201
- * @property { Margins } [margins] Set margins for the printed web page
18202
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
18203
- * @property { number } [scaleFactor] The scale factor of the web page.
18204
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
18205
- * @property { boolean } [collate] Whether the web page should be collated.
18206
- * @property { number } [copies] The number of copies of the web page to print.
18207
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
18208
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
18209
- * @property { Dpi } [dpi] Set dpi for the printed web page
18210
- */
18211
- /**
18212
- * @REMOVED
18213
- * PrinterInfo interface
18214
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
18215
- * @property { string } name Printer Name
18216
- * @property { string } description Printer Description
18217
- * @property { number } status Printer Status
18218
- * @property { boolean } isDefault Indicates that system's default printer
18219
- */
18220
- /**
18221
- * @REMOVED
18222
- * SharedWorkerInfo interface
18223
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
18224
- * @property { string } id The unique id of the shared worker.
18225
- * @property { string } url The url of the shared worker.
18226
- */
18227
- /**
18228
- * @PORTED
18229
- * ContentCreationRule interface
18230
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
18231
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
18232
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
18233
- * @property { object } options Window creation options or View creation options.
18234
- */
18235
- /**
18236
- * @PORTED
18237
- * @typedef {object} Window~options
18238
- * @summary Window creation options.
18239
- * @desc This is the options object required by {@link Window.create Window.create}.
18240
- *
18241
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18242
- * (defaults to `"about:blank"` when omitted).
18243
- *
18244
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
18245
- *
18246
- * @property {object} [accelerator]
18247
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
18248
- *
18249
- * @property {boolean} [accelerator.devtools=false]
18250
- * If `true`, enables the devtools keyboard shortcut:<br>
18251
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
18252
- *
18253
- * @property {boolean} [accelerator.reload=false]
18254
- * If `true`, enables the reload keyboard shortcuts:<br>
18255
- * `Ctrl` + `R` _(Windows)_<br>
18256
- * `F5` _(Windows)_<br>
18257
- * `Command` + `R` _(Mac)_
18258
- *
18259
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
18260
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
18261
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
18262
- * `Shift` + `F5` _(Windows)_<br>
18263
- * `Command` + `Shift` + `R` _(Mac)_
18264
- *
18265
- * @property {boolean} [accelerator.zoom=false]
18266
- * 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.
18267
- * If `true`, enables the zoom keyboard shortcuts:<br>
18268
- * `Ctrl` + `+` _(Zoom In)_<br>
18269
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
18270
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
18271
- * `Ctrl` + `-` _(Zoom Out)_<br>
18272
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
18273
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
18274
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
18275
- * `Ctrl` + `0` _(Restore to 100%)_
18276
- *
18277
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
18278
- * <br>
18279
- * alphaMask turns anything of matching RGB value transparent.
18280
- * <br>
18281
- * Caveats:
18282
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
18283
- * * User cannot click-through transparent regions
18284
- * * Not supported on Mac
18285
- * * Windows Aero must be enabled
18286
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
18287
- * * Not supported on rounded corner windows
18288
- * @property {number} [alphaMask.red=-1] 0-255
18289
- * @property {number} [alphaMask.green=-1] 0-255
18290
- * @property {number} [alphaMask.blue=-1] 0-255
18291
- *
18292
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
18293
- * A flag to always position the window at the top of the window stack.
18294
- *
18295
- * @property {object} [api]
18296
- * Configurations for API injection.
18297
- *
18298
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
18299
- *
18300
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
18301
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
18302
- *
18303
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
18304
- *
18305
- * @property {number} [aspectRatio=0] - _Updatable._
18306
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
18307
- * an aspect ratio will not be enforced.
18308
- *
18309
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
18310
- * Autoplay policy to apply to content in the window, can be
18311
- * `no-user-gesture-required`, `user-gesture-required`,
18312
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
18313
- *
18314
- * @property {boolean} [autoShow=true]
18315
- * A flag to automatically show the window when it is created.
18316
- *
18317
- * @property {string} [backgroundColor="#FFF"]
18318
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
18319
- * (`document.body.style.backgroundColor`),
18320
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
18321
- * areas when growing a window. Setting
18322
- * this value to the anticipated content background color can help improve user experience.
18323
- * Default is white.
18324
- *
18325
- * @property {object} [contentCreation]
18326
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
18327
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
18328
- *
18329
- * @property {object} [contentNavigation]
18330
- * Restrict navigation to URLs that match an allowed pattern.
18331
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
18332
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
18333
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
18334
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
18335
- *
18336
- * @property {object} [contentRedirect]
18337
- * Restrict redirects to URLs that match an allowed pattern.
18338
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
18339
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
18340
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
18341
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
18342
- *
18343
- * @property {boolean} [contextMenu=true] - _Updatable._
18344
- * A flag to show the context menu when right-clicking on a window.
18345
- * Gives access to the devtools for the window.
18346
- *
18347
- * @property {object} [contextMenuSettings] - _Updatable._
18348
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
18349
- * Configure the context menu when right-clicking on a window.
18350
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
18351
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
18352
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
18353
- *
18354
- * @property {object} [contextMenuOptions] - _Updatable._
18355
- * Configure the context menu when right-clicking on a window. Supported menu items:
18356
- * 'separator'
18357
- * 'cut'
18358
- * 'copy'
18359
- * 'paste'
18360
- * 'spellCheck'
18361
- * 'inspect'
18362
- * 'reload'
18363
- * 'navigateForward'
18364
- * 'navigateBack'
18365
- * 'print'
18366
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
18367
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
18368
- *
18369
- * @property {object} [cornerRounding] - _Updatable._
18370
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
18371
- * average of _height_ and _width_.
18372
- * @property {number} [cornerRounding.height=0] The height in pixels.
18373
- * @property {number} [cornerRounding.width=0] The width in pixels.
18374
- *
18375
- * @property {any} [customContext=""] - _Updatable. Inheritable._
18376
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
18377
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
18378
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
18379
- * _When omitted, _inherits_ from the parent application._
18380
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
18381
- *
18382
- * @property {any} [customData=""] - _Updatable. Inheritable._
18383
- * A field that the user can attach serializable data to be ferried around with the window options.
18384
- * _When omitted, _inherits_ from the parent application._
18385
- *
18386
- * @property {object[]} [customRequestHeaders]
18387
- * Defines list of custom headers for requests sent by the window.
18388
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
18389
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
18390
- * where the object key is the name of header and value at key is the value of the header
18391
- *
18392
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
18393
- * Toggling off would keep the Window alive even if all its Views were closed.
18394
- * This is meant for advanced users and should be used with caution.
18395
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
18396
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
18397
- * ** note ** - This option is ignored in non-Platforms apps.
18398
- *
18399
- * @property {boolean} [defaultCentered=false]
18400
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
18401
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
18402
- * somewhat above center vertically.
18403
- *
18404
- * @property {number} [defaultHeight=500]
18405
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
18406
- * in favor of the cached value.
18407
- *
18408
- * @property {number} [defaultLeft=100]
18409
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18410
- * launches in favor of the cached value.
18411
- *
18412
- * @property {number} [defaultTop=100]
18413
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18414
- * launches in favor of the cached value.
18415
- *
18416
- * @property {number} [defaultWidth=800]
18417
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
18418
- * launches in favor of the cached value.
18419
- *
18420
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
18421
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
18422
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
18423
- *
18424
- * @property {boolean} [frame=true] - _Updatable._
18425
- * A flag to show the frame.
18426
- *
18427
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
18428
- *
18429
- * @property {object[]} [hotkeys=[]] - _Updatable._
18430
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
18431
- * Within Platform, OpenFin also implements a set of pre-defined actions called
18432
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
18433
- * that can be assigned to a specific hotkey in the platform manifest.
18434
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
18435
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
18436
- *
18437
- * @property {string} [icon] - _Updatable. Inheritable._
18438
- * A URL for the icon to be shown in the window title bar and the taskbar.
18439
- * When omitted, inherits from the parent application._
18440
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
18441
- *
18442
- * @property {number} [maxHeight=-1] - _Updatable._
18443
- * The maximum height of a window. Will default to the OS defined value if set to -1.
18444
- *
18445
- * @property {boolean} [maximizable=true] - _Updatable._
18446
- * A flag that lets the window be maximized.
18447
- *
18448
- * @property {number} [maxWidth=-1] - _Updatable._
18449
- * The maximum width of a window. Will default to the OS defined value if set to -1.
18450
- *
18451
- * @property {number} [minHeight=0] - _Updatable._
18452
- * The minimum height of a window.
18453
- *
18454
- * @property {boolean} [minimizable=true] - _Updatable._
18455
- * A flag that lets the window be minimized.
18456
- *
18457
- * @property {number} [minWidth=0] - _Updatable._
18458
- * The minimum width of a window.
18459
- *
18460
- * @property {Identity} [modalParentIdentity]
18461
- * Parent identity of a modal window. It will create a modal child window when this option is set.
18462
- *
18463
- * @property {string} name
18464
- * The name of the window.
18465
- *
18466
- * @property {number} [opacity=1.0] - _Updatable._
18467
- * A flag that specifies how transparent the window will be.
18468
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
18469
- * This value is clamped between `0.0` and `1.0`.
18470
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
18471
- *
18472
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
18473
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
18474
- * from the parent application.
18475
- *
18476
- * @property {string} [processAffinity]
18477
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
18478
- *
18479
- * @property {boolean} [resizable=true] - _Updatable._
18480
- * A flag to allow the user to resize the window.
18481
- *
18482
- * @property {object} [resizeRegion] - _Updatable._
18483
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
18484
- * @property {number} [resizeRegion.bottomRightCorner=9]
18485
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
18486
- * @property {number} [resizeRegion.size=7]
18487
- * The size in pixels.
18488
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
18489
- * Sides that a window can be resized from.
18490
- *
18491
- * @property {boolean} [saveWindowState=true]
18492
- * A flag to cache the location of the window.
18493
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
18494
- *
18495
- * @property {boolean} [ignoreSavedWindowState]
18496
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
18497
- *
18498
- * @property {boolean} [shadow=false]
18499
- * A flag to display a shadow on frameless windows.
18500
- * `shadow` and `cornerRounding` are mutually exclusive.
18501
- * On Windows 7, Aero theme is required.
18502
- *
18503
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
18504
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
18505
- * This occurs when the window is resizing or a tab is being dragged within the layout.
18506
- *
18507
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
18508
- * A flag to show the window's icon in the taskbar.
18509
- *
18510
- * @property {boolean} [smallWindow=false]
18511
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
18512
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
18513
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
18514
- *
18515
- * @property {boolean} [spellCheck=false]
18516
- * Enable spell check in input text fields for the window.
18517
- *
18518
- * @property {string} [state="normal"]
18519
- * The visible state of the window on creation.
18520
- * One of:
18521
- * * `"maximized"`
18522
- * * `"minimized"`
18523
- * * `"normal"`
18524
- *
18525
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
18526
- *
18527
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
18528
- * Specify a taskbar group for the window.
18529
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
18530
- *
18531
- * @property {string} [url="about:blank"]
18532
- * The URL of the window.
18533
- *
18534
- * @property {string} [uuid=<application uuid>]
18535
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
18536
- * If omitted, defaults to the `uuid` of the application spawning the window.
18537
- * If given, must match the `uuid` of the application spawning the window.
18538
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
18539
- * really no need to provide it.
18540
- *
18541
- * @property {boolean} [waitForPageLoad=false]
18542
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
18543
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
18544
- *
18545
- * @property {ViewVisibility} [viewVisibility]
18546
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18547
- */
18548
- /**
18549
- * @PORTED
18550
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18551
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
18552
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18553
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
18554
- */
18555
- /**
18556
- * @PORTED
18557
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
18558
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
18559
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
18560
- */
18561
- /**
18562
- * @REMOVED
18563
- * @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.
18564
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
18565
- */
18566
- /**
18567
- * @REMOVED
18568
- * @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.
18569
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
18570
- */
18571
- /**
18572
- * @PORTED
18573
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
18574
- * @property { Area } [area] The area of the window to be captured.
18575
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
18576
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
18577
- */
18578
- /**
18579
- * @PORTED
18580
- * @typedef { object } Area@typedef { object } Area
18581
- * @property { number } height Area's height
18582
- * @property { number } width Area's width
18583
- * @property { number } x X coordinate of area's starting point
18584
- * @property { number } y Y coordinate of area's starting point
18585
- */
18586
- /**
18587
- * @PORTED
18588
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
18589
- * @property {boolean} [forward=true] Whether to search forward or backward.
18590
- * @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.
18591
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
18592
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
18593
- * @property {boolean} [medialCapitalAsWordStart=false]
18594
- * 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>
18595
- * lowercase or non-letter. Accepts several other intra-word matches.
18596
- */
18597
- /**
18598
- * @REMOVED
18599
- * @typedef {object} Transition@typedef {object} Transition
18600
- * @property {Opacity} opacity - The Opacity transition
18601
- * @property {Position} position - The Position transition
18602
- * @property {Size} size - The Size transition
18603
- */
18604
- /**
18605
- * @PORTED
18606
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
18607
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
18608
- this animation onto the end of the animation queue.
18609
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18610
- */
18611
- /**
18612
- * @PORTED
18613
- * @typedef {object} Size@typedef {object} Size
18614
- * @property {number} duration - The total time in milliseconds this transition should take.
18615
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18616
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
18617
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
18618
- */
18619
- /**
18620
- * @PORTED
18621
- * @typedef {object} Position@typedef {object} Position
18622
- * @property {number} duration - The total time in milliseconds this transition should take.
18623
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18624
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
18625
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
18626
- */
18627
- /**
18628
- * @PORTED
18629
- * @typedef {object} Opacity@typedef {object} Opacity
18630
- * @property {number} duration - The total time in milliseconds this transition should take.
18631
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18632
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
18633
- */
18634
- /**
18635
- * @REMOVED
18636
- * Bounds is a interface that has the properties of height,
18637
- * width, left, top which are all numbers
18638
- * @typedef { object } Bounds@typedef { object } Bounds
18639
- * @property { number } height Get the application height bound
18640
- * @property { number } width Get the application width bound
18641
- * @property { number } top Get the application top bound
18642
- * @property { number } left Get the application left bound
18643
- * @property { number } right Get the application right bound
18644
- * @property { number } bottom Get the application bottom bound
18645
- */
18646
17528
  /**
18647
17529
  * A basic window that wraps a native HTML window. Provides more fine-grained
18648
17530
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18655,83 +17537,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18655
17537
  * @internal
18656
17538
  */
18657
17539
  constructor(wire: Transport, identity: OpenFin_2.Identity);
18658
- /**
18659
- * Adds a listener to the end of the listeners array for the specified event.
18660
- * @param eventType - The type of the event.
18661
- * @param listener - Called whenever an event of the specified type occurs.
18662
- * @param options - Option to support event timestamps.
18663
- *
18664
- * @function addListener
18665
- * @memberof Window
18666
- * @instance
18667
- * @tutorial Window.EventEmitter
18668
- */
18669
- /**
18670
- * Adds a listener to the end of the listeners array for the specified event.
18671
- * @param eventType - The type of the event.
18672
- * @param listener - Called whenever an event of the specified type occurs.
18673
- * @param options - Option to support event timestamps.
18674
- *
18675
- * @function on
18676
- * @memberof Window
18677
- * @instance
18678
- * @tutorial Window.EventEmitter
18679
- */
18680
- /**
18681
- * 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.
18682
- * @param eventType - The type of the event.
18683
- * @param listener - The callback function.
18684
- * @param options - Option to support event timestamps.
18685
- *
18686
- * @function once
18687
- * @memberof Window
18688
- * @instance
18689
- * @tutorial Window.EventEmitter
18690
- */
18691
- /**
18692
- * Adds a listener to the beginning of the listeners array for the specified event.
18693
- * @param eventType - The type of the event.
18694
- * @param listener - The callback function.
18695
- * @param options - Option to support event timestamps.
18696
- *
18697
- * @function prependListener
18698
- * @memberof Window
18699
- * @instance
18700
- * @tutorial Window.EventEmitter
18701
- */
18702
- /**
18703
- * 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.
18704
- * The listener is added to the beginning of the listeners array.
18705
- * @param eventType - The type of the event.
18706
- * @param listener - The callback function.
18707
- * @param options - Option to support event timestamps.
18708
- *
18709
- * @function prependOnceListener
18710
- * @memberof Window
18711
- * @instance
18712
- * @tutorial Window.EventEmitter
18713
- */
18714
- /**
18715
- * Remove a listener from the listener array for the specified event.
18716
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
18717
- * @param eventType - The type of the event.
18718
- * @param listener - The callback function.
18719
- * @param options - Option to support event timestamps.
18720
- *
18721
- * @function removeListener
18722
- * @memberof Window
18723
- * @instance
18724
- * @tutorial Window.EventEmitter
18725
- */
18726
- /**
18727
- * Removes all listeners, or those of the specified event.
18728
- * @param eventType - The type of the event.
18729
- *
18730
- * @function removeAllListeners
18731
- * @memberof Window
18732
- * @instance
18733
- * @tutorial Window.EventEmitter
18734
- */
18735
17540
  /**
18736
17541
  * create a new window
18737
17542
  * @internal
@@ -19577,28 +18382,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19577
18382
  * ```
19578
18383
  */
19579
18384
  authenticate(userName: string, password: string): Promise<void>;
19580
- /**
19581
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
19582
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
19583
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
19584
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
19585
- */
19586
- /**
19587
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
19588
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
19589
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
19590
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
19591
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
19592
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
19593
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
19594
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
19595
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
19596
- */
19597
- /**
19598
- * @typedef {object} MenuResult@typedef {object} MenuResult
19599
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
19600
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
19601
- */
19602
18385
  /**
19603
18386
  * Shows a menu on the window.
19604
18387
  *
@@ -19695,590 +18478,565 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19695
18478
  */
19696
18479
  closePopupMenu(): Promise<void>;
19697
18480
  /**
19698
- * @PORTED
19699
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19700
- * @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.
19701
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19702
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19703
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19704
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19705
- * @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.
19706
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19707
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19708
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19709
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19710
- * @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.
19711
- * @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`.
19712
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19713
- * @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.
19714
- */
19715
- /**
19716
- * @PORTED
19717
- * @typedef {object} PopupResult@typedef {object} PopupResult
19718
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19719
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19720
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19721
- */
19722
- /**
19723
- * Dispatch a result to the caller of `showPopupWindow`.
19724
- *
19725
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19726
- * @param data Serializable data to send to the caller window.
19727
- *
19728
- * @example
19729
- * ```js
19730
- * await fin.me.dispatchPopupResult({
19731
- * foo: 'bar'
19732
- * });
19733
- * ```
19734
- */
19735
- dispatchPopupResult(data: any): Promise<void>;
19736
- /**
19737
- * Prints the contents of the window.
19738
- *
19739
- * @param options Configuration for the print task.
19740
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19741
- * and the default settings for printing.
19742
- *
19743
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19744
- *
19745
- * @example
19746
- * ```js
19747
- * const win = fin.Window.getCurrentSync();
19748
- *
19749
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19750
- * console.log('print call has been sent to the system');
19751
- * });
19752
- * ```
19753
- *
19754
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19755
- * use the `content` option:
19756
- *
19757
- * ```js
19758
- * const win = fin.Window.getCurrentSync();
19759
- *
19760
- * // Print embedded views
19761
- * win.print({ content: 'views' });
19762
- *
19763
- * // Print screenshot of current window
19764
- * win.print({ content: 'screenshot' })
19765
- * ```
19766
- *
19767
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19768
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19769
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19770
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19771
- *
19772
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19773
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19774
- *
19775
- * To print the views embedded in their page context, set `content` to `screenshot`.
19776
- */
19777
- print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
19778
- }
19779
-
19780
- /**
19781
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19782
- * @interface
19783
- */
19784
- declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19785
- type: 'window-alert-requested';
19786
- };
19787
-
19788
- /**
19789
- * Returned from getBounds call. bottom and right are never used for setting.
19790
- * @interface
19791
- */
19792
- declare type WindowBounds = Bounds & {
19793
- bottom: number;
19794
- right: number;
19795
- };
19796
-
19797
- /**
19798
- * @deprecated Renamed to {@link ClosedEvent}.
19799
- */
19800
- declare type WindowClosedEvent = ClosedEvent_2;
19801
-
19802
- /**
19803
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19804
- */
19805
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19806
-
19807
- /**
19808
- * @deprecated Renamed to {@link ClosingEvent}.
19809
- */
19810
- declare type WindowClosingEvent = ClosingEvent;
19811
-
19812
- /**
19813
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19814
- *
19815
- * @interface
19816
- */
19817
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19818
- /**
19819
- * Behavior to use when opening matched content.
19820
- */
19821
- behavior: 'window';
19822
- /**
19823
- * Options for newly-created window.
19824
- */
19825
- options?: Partial<WindowOptions>;
19826
- };
19827
-
19828
- /**
19829
- * Generated when a child window is created.
19830
- * @interface
19831
- */
19832
- declare type WindowCreatedEvent = BaseEvent_3 & {
19833
- type: 'window-created';
19834
- };
19835
-
19836
- /**
19837
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19838
- *
19839
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19840
- * (defaults to `"about:blank"` when omitted).
19841
- * @interface
19842
- */
19843
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19844
- name: string;
19845
- };
19846
-
19847
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19848
-
19849
- /**
19850
- * @interface
19851
- */
19852
- declare type WindowDetail = {
19853
- /**
19854
- * The bottom-most coordinate of the window.
19855
- */
19856
- bottom: number;
19857
- /**
19858
- * The height of the window.
19859
- */
19860
- height: number;
19861
- isShowing: boolean;
19862
- /**
19863
- * The left-most coordinate of the window.
19864
- */
19865
- left: number;
19866
- /**
19867
- * The name of the window.
19868
- */
19869
- name: string;
19870
- /**
19871
- * The right-most coordinate of the window.
19872
- */
19873
- right: number;
19874
- state: string;
19875
- /**
19876
- * The top-most coordinate of the window.
19877
- */
19878
- top: number;
19879
- /**
19880
- * The width of the window.
19881
- */
19882
- width: number;
19883
- };
19884
-
19885
- /**
19886
- * Generated when a child window ends loading.
19887
- * @interface
19888
- */
19889
- declare type WindowEndLoadEvent = BaseEvent_3 & {
19890
- type: 'window-end-load';
19891
- };
19892
-
19893
- /**
19894
- * @deprecated, Renamed to {@link Event}.
19895
- */
19896
- declare type WindowEvent = Event_6;
19897
-
19898
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19899
-
19900
- declare namespace WindowEvents {
19901
- export {
19902
- BaseEvent_5 as BaseEvent,
19903
- BaseWindowEvent,
19904
- ViewAttachedEvent,
19905
- ViewDetachedEvent,
19906
- WindowViewEvent,
19907
- AlertRequestedEvent,
19908
- AuthRequestedEvent,
19909
- EndLoadEvent,
19910
- WillRedirectEvent,
19911
- ReloadedEvent,
19912
- OptionsChangedEvent,
19913
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19914
- ExternalProcessExitedEvent,
19915
- ExternalProcessStartedEvent,
19916
- HiddenEvent_2 as HiddenEvent,
19917
- WindowHiddenEvent,
19918
- PreloadScriptInfoRunning,
19919
- PreloadScriptInfo,
19920
- PreloadScriptsStateChangeEvent,
19921
- UserBoundsChangeEvent,
19922
- BoundsChangeEvent,
19923
- WillMoveOrResizeEvent,
19924
- PerformanceReportEvent,
19925
- InputEvent_2 as InputEvent,
19926
- LayoutInitializedEvent,
19927
- LayoutReadyEvent,
19928
- BeginUserBoundsChangingEvent,
19929
- BoundsChangedEvent,
19930
- BoundsChangingEvent,
19931
- CloseRequestedEvent,
19932
- WindowCloseRequestedEvent,
19933
- ContextChangedEvent,
19934
- ClosedEvent_2 as ClosedEvent,
19935
- WindowClosedEvent,
19936
- ClosingEvent,
19937
- WindowClosingEvent,
19938
- DisabledMovementBoundsChangedEvent,
19939
- DisabledMovementBoundsChangingEvent,
19940
- EmbeddedEvent,
19941
- EndUserBoundsChangingEvent,
19942
- HotkeyEvent_2 as HotkeyEvent,
19943
- WindowHotkeyEvent,
19944
- InitializedEvent_2 as InitializedEvent,
19945
- WindowInitializedEvent,
19946
- MaximizedEvent,
19947
- MinimizedEvent,
19948
- PreloadScriptsStateChangedEvent,
19949
- PreloadScriptsStateChangingEvent,
19950
- RestoredEvent,
19951
- WindowRestoredEvent,
19952
- ShowRequestedEvent,
19953
- WindowShowRequestedEvent,
19954
- ShownEvent_2 as ShownEvent,
19955
- WindowShownEvent,
19956
- UserMovementEnabledEvent,
19957
- UserMovementDisabledEvent,
19958
- WillMoveEvent,
19959
- WillResizeEvent,
19960
- NonPropagatedWindowEvent,
19961
- ShowAllDownloadsEvent,
19962
- DownloadShelfVisibilityChangedEvent,
19963
- WindowSourcedEvent,
19964
- WillPropagateWindowEvent,
19965
- Event_6 as Event,
19966
- WindowEvent,
19967
- EventType_2 as EventType,
19968
- WindowEventType,
19969
- PropagatedEvent_3 as PropagatedEvent,
19970
- PropagatedWindowEvent,
19971
- PropagatedWindowEventType,
19972
- Payload_3 as Payload,
19973
- ByType_2 as ByType
19974
- }
19975
- }
19976
-
19977
- /**
19978
- * @deprecated Renamed to {@link EventType}.
19979
- */
19980
- declare type WindowEventType = WindowEvent['type'];
19981
-
19982
- /**
19983
- * @deprecated Renamed to {@link HiddenEvent}.
19984
- */
19985
- declare type WindowHiddenEvent = HiddenEvent_2;
19986
-
19987
- /**
19988
- * @deprecated Renamed to {@link HotkeyEvent}.
19989
- */
19990
- declare type WindowHotkeyEvent = HotkeyEvent_2;
19991
-
19992
- /**
19993
- * @interface
19994
- */
19995
- declare type WindowInfo = {
19996
- canNavigateBack: boolean;
19997
- canNavigateForward: boolean;
19998
- preloadScripts: Array<any>;
19999
- title: string;
20000
- url: string;
20001
- };
20002
-
20003
- /**
20004
- * @deprecated Renamed to {@link InitializedEvent}.
20005
- */
20006
- declare type WindowInitializedEvent = InitializedEvent_2;
20007
-
20008
- /**
20009
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
20010
- */
20011
- declare class _WindowModule extends Base {
20012
- /**
20013
- * Asynchronously returns a Window object that represents an existing window.
20014
- *
20015
- * @example
20016
- * ```js
20017
- * async function createWin() {
20018
- * const app = await fin.Application.start({
20019
- * name: 'myApp',
20020
- * uuid: 'app-1',
20021
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
20022
- * autoShow: true
20023
- * });
20024
- * return await app.getWindow();
20025
- * }
20026
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
20027
- * .then(win => console.log('wrapped window'))
20028
- * .catch(err => console.log(err));
20029
- * ```
20030
- */
20031
- wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
20032
- /**
20033
- * Synchronously returns a Window object that represents an existing window.
20034
- *
20035
- * @example
20036
- * ```js
20037
- * async function createWin() {
20038
- * const app = await fin.Application.start({
20039
- * name: 'myApp',
20040
- * uuid: 'app-1',
20041
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
20042
- * autoShow: true
20043
- * });
20044
- * return await app.getWindow();
20045
- * }
20046
- * await createWin();
20047
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
20048
- * ```
20049
- */
20050
- wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
20051
- /**
20052
- * Creates a new Window.
20053
- * @param options - Window creation options
20054
- *
20055
- * @example
20056
- * ```js
20057
- * async function createWindow() {
20058
- * const winOption = {
20059
- * name:'child',
20060
- * defaultWidth: 300,
20061
- * defaultHeight: 300,
20062
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
20063
- * frame: true,
20064
- * autoShow: true
20065
- * };
20066
- * return await fin.Window.create(winOption);
20067
- * }
20068
- *
20069
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
20070
- * ```
20071
- */
20072
- create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
20073
- /**
20074
- * Asynchronously returns a Window object that represents the current window
20075
- *
20076
- * @example
20077
- * ```js
20078
- * fin.Window.getCurrent()
20079
- * .then(wnd => console.log('current window'))
20080
- * .catch(err => console.log(err));
20081
- *
20082
- * ```
20083
- */
20084
- getCurrent(): Promise<OpenFin_2.Window>;
20085
- /**
20086
- * Synchronously returns a Window object that represents the current window
20087
- *
20088
- * @example
20089
- * ```js
20090
- * const wnd = fin.Window.getCurrentSync();
20091
- * const info = await wnd.getInfo();
20092
- * console.log(info);
20093
- *
20094
- * ```
20095
- */
20096
- getCurrentSync(): OpenFin_2.Window;
20097
- }
20098
-
20099
- /**
20100
- * Generated when a child window is not responding.
20101
- * @interface
20102
- */
20103
- declare type WindowNotRespondingEvent = BaseEvent_3 & {
20104
- type: 'window-not-responding';
20105
- };
20106
-
20107
- /**
20108
- * @interface
20109
- */
20110
- declare type WindowOptionDiff = {
20111
- [key in keyof WindowOptions]: {
20112
- oldVal: WindowOptions[key];
20113
- newVal: WindowOptions[key];
20114
- };
20115
- };
20116
-
20117
- /**
20118
- * @interface
20119
- */
20120
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
20121
-
20122
- declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
20123
-
20124
- /**
20125
- * @deprecated Renamed to {@link OptionsChangedEvent}.
20126
- */
20127
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
20128
-
20129
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
20130
-
20131
- /**
20132
- * Generated when a child window is responding.
20133
- * @interface
20134
- */
20135
- declare type WindowRespondingEvent = BaseEvent_3 & {
20136
- type: 'window-responding';
20137
- };
20138
-
20139
- /**
20140
- * @deprecated Renamed to {@link RestoredEvent}.
20141
- */
20142
- declare type WindowRestoredEvent = RestoredEvent;
20143
-
20144
- /**
20145
- * @deprecated Renamed to {@link ShownEvent}.
20146
- */
20147
- declare type WindowShownEvent = ShownEvent_2;
20148
-
20149
- /**
20150
- * @deprecated Renamed to {@link ShowRequestedEvent}.
20151
- */
20152
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
20153
-
20154
- /**
20155
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
20156
- * from {@link OpenFin.ViewEvents}.
20157
- */
20158
- 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;
20159
-
20160
- /**
20161
- * Generated when a child window starts loading.
20162
- * @interface
20163
- */
20164
- declare type WindowStartLoadEvent = BaseEvent_3 & {
20165
- type: 'window-start-load';
20166
- };
20167
-
20168
- /**
20169
- * Visibility state of a window.
20170
- */
20171
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
20172
-
20173
- /**
20174
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
20175
- * to the `Application` level, with the name pattern `window-view-eventname`.
20176
- */
20177
- declare type WindowViewEvent = {
20178
- viewIdentity: OpenFin_2.Identity;
20179
- } & (ViewAttachedEvent | ViewDetachedEvent);
20180
-
20181
- /**
20182
- * @interface
20183
- */
20184
- declare type WindowViewsPrintOptions = {
20185
- content: 'views';
20186
- includeSelf?: boolean;
20187
- };
20188
-
20189
- declare type Wire = EventEmitter & {
20190
- connect(messageReciever: MessageReceiver): Promise<any>;
20191
- connectSync(): any;
20192
- send(data: any): Promise<any>;
20193
- shutdown(): Promise<void>;
20194
- getPort(): string;
20195
- };
20196
-
20197
- declare type WireConstructor = {
20198
- new (onmessage: (data: any) => void): Wire;
20199
- };
20200
-
20201
- /**
20202
- * @internal
20203
- */
20204
- declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
20205
-
20206
- declare interface WithInterop {
20207
- interop: InteropClient;
20208
- }
20209
-
20210
- /**
20211
- * @internal
20212
- */
20213
- declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
20214
-
20215
- declare type WithPositioningOptions<T extends {} = {}> = T & {
20216
- positioningOptions?: OpenFin_2.PositioningOptions;
20217
- };
20218
-
20219
- /**
20220
- * @internal
20221
- * @interface
20222
- */
20223
- declare type WorkspacePlatformOptions = {
20224
- /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
20225
- [key: string]: any;
20226
- };
20227
-
20228
- /**
20229
- * A generic request to write any supported data to the clipboard.
20230
- * @interface
20231
- */
20232
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
20233
- /**
20234
- * Data to be written
20235
- */
20236
- data: {
20237
- text?: string;
20238
- html?: string;
20239
- rtf?: string;
20240
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
20241
- };
20242
-
20243
- /**
20244
- * @deprecated - instead use WriteAnyClipboardRequest
20245
- *
20246
- * A generic request to write any supported data to the clipboard.
20247
- *
20248
- * @interface
20249
- */
20250
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
20251
-
20252
- /**
20253
- * A request to write data to the clipboard.
20254
- * @interface
20255
- */
20256
- declare type WriteClipboardRequest = BaseClipboardRequest & {
20257
- /**
20258
- * Data to write to the clipboard.
20259
- */
20260
- data: string;
20261
- };
20262
-
20263
- /**
20264
- * @interface
20265
- */
20266
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
20267
- /**
20268
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
20269
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
20270
- * Using other image/<format> DataURLs will throw an Error.
20271
- */
20272
- image: string;
20273
- };
20274
-
20275
- /**
20276
- * @deprecated - instead use OpenFin.WriteClipboardRequest
20277
- *
20278
- * A request to write data to the clipboard.
20279
- *
20280
- * @interface
20281
- */
20282
- declare type WriteRequestType = WriteClipboardRequest;
20283
-
20284
- export { }
18481
+ * Dispatch a result to the caller of `showPopupWindow`.
18482
+ *
18483
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18484
+ * @param data Serializable data to send to the caller window.
18485
+ *
18486
+ * @example
18487
+ * ```js
18488
+ * await fin.me.dispatchPopupResult({
18489
+ * foo: 'bar'
18490
+ * });
18491
+ * ```
18492
+ */
18493
+ dispatchPopupResult(data: any): Promise<void>;
18494
+ /**
18495
+ * Prints the contents of the window.
18496
+ *
18497
+ * @param options Configuration for the print task.
18498
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18499
+ * and the default settings for printing.
18500
+ *
18501
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18502
+ *
18503
+ * @example
18504
+ * ```js
18505
+ * const win = fin.Window.getCurrentSync();
18506
+ *
18507
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18508
+ * console.log('print call has been sent to the system');
18509
+ * });
18510
+ * ```
18511
+ *
18512
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18513
+ * use the `content` option:
18514
+ *
18515
+ * ```js
18516
+ * const win = fin.Window.getCurrentSync();
18517
+ *
18518
+ * // Print embedded views
18519
+ * win.print({ content: 'views' });
18520
+ *
18521
+ * // Print screenshot of current window
18522
+ * win.print({ content: 'screenshot' })
18523
+ * ```
18524
+ *
18525
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18526
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18527
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18528
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18529
+ *
18530
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18531
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18532
+ *
18533
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18534
+ */
18535
+ print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
18536
+ }
18537
+
18538
+ /**
18539
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18540
+ * @interface
18541
+ */
18542
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18543
+ type: 'window-alert-requested';
18544
+ };
18545
+
18546
+ /**
18547
+ * Returned from getBounds call. bottom and right are never used for setting.
18548
+ * @interface
18549
+ */
18550
+ declare type WindowBounds = Bounds & {
18551
+ bottom: number;
18552
+ right: number;
18553
+ };
18554
+
18555
+ /**
18556
+ * @deprecated Renamed to {@link ClosedEvent}.
18557
+ */
18558
+ declare type WindowClosedEvent = ClosedEvent_2;
18559
+
18560
+ /**
18561
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18562
+ */
18563
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18564
+
18565
+ /**
18566
+ * @deprecated Renamed to {@link ClosingEvent}.
18567
+ */
18568
+ declare type WindowClosingEvent = ClosingEvent;
18569
+
18570
+ /**
18571
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18572
+ *
18573
+ * @interface
18574
+ */
18575
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18576
+ /**
18577
+ * Behavior to use when opening matched content.
18578
+ */
18579
+ behavior: 'window';
18580
+ /**
18581
+ * Options for newly-created window.
18582
+ */
18583
+ options?: Partial<WindowOptions>;
18584
+ };
18585
+
18586
+ /**
18587
+ * Generated when a child window is created.
18588
+ * @interface
18589
+ */
18590
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18591
+ type: 'window-created';
18592
+ };
18593
+
18594
+ /**
18595
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18596
+ *
18597
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18598
+ * (defaults to `"about:blank"` when omitted).
18599
+ * @interface
18600
+ */
18601
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18602
+ name: string;
18603
+ };
18604
+
18605
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18606
+
18607
+ /**
18608
+ * @interface
18609
+ */
18610
+ declare type WindowDetail = {
18611
+ /**
18612
+ * The bottom-most coordinate of the window.
18613
+ */
18614
+ bottom: number;
18615
+ /**
18616
+ * The height of the window.
18617
+ */
18618
+ height: number;
18619
+ isShowing: boolean;
18620
+ /**
18621
+ * The left-most coordinate of the window.
18622
+ */
18623
+ left: number;
18624
+ /**
18625
+ * The name of the window.
18626
+ */
18627
+ name: string;
18628
+ /**
18629
+ * The right-most coordinate of the window.
18630
+ */
18631
+ right: number;
18632
+ state: string;
18633
+ /**
18634
+ * The top-most coordinate of the window.
18635
+ */
18636
+ top: number;
18637
+ /**
18638
+ * The width of the window.
18639
+ */
18640
+ width: number;
18641
+ };
18642
+
18643
+ /**
18644
+ * Generated when a child window ends loading.
18645
+ * @interface
18646
+ */
18647
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18648
+ type: 'window-end-load';
18649
+ };
18650
+
18651
+ /**
18652
+ * @deprecated, Renamed to {@link Event}.
18653
+ */
18654
+ declare type WindowEvent = Event_6;
18655
+
18656
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18657
+
18658
+ declare namespace WindowEvents {
18659
+ export {
18660
+ BaseEvent_5 as BaseEvent,
18661
+ BaseWindowEvent,
18662
+ ViewAttachedEvent,
18663
+ ViewDetachedEvent,
18664
+ WindowViewEvent,
18665
+ AlertRequestedEvent,
18666
+ AuthRequestedEvent,
18667
+ EndLoadEvent,
18668
+ WillRedirectEvent,
18669
+ ReloadedEvent,
18670
+ OptionsChangedEvent,
18671
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18672
+ ExternalProcessExitedEvent,
18673
+ ExternalProcessStartedEvent,
18674
+ HiddenEvent_2 as HiddenEvent,
18675
+ WindowHiddenEvent,
18676
+ PreloadScriptInfoRunning,
18677
+ PreloadScriptInfo,
18678
+ PreloadScriptsStateChangeEvent,
18679
+ UserBoundsChangeEvent,
18680
+ BoundsChangeEvent,
18681
+ WillMoveOrResizeEvent,
18682
+ PerformanceReportEvent,
18683
+ InputEvent_2 as InputEvent,
18684
+ LayoutInitializedEvent,
18685
+ LayoutReadyEvent,
18686
+ BeginUserBoundsChangingEvent,
18687
+ BoundsChangedEvent,
18688
+ BoundsChangingEvent,
18689
+ CloseRequestedEvent,
18690
+ WindowCloseRequestedEvent,
18691
+ ContextChangedEvent,
18692
+ ClosedEvent_2 as ClosedEvent,
18693
+ WindowClosedEvent,
18694
+ ClosingEvent,
18695
+ WindowClosingEvent,
18696
+ DisabledMovementBoundsChangedEvent,
18697
+ DisabledMovementBoundsChangingEvent,
18698
+ EmbeddedEvent,
18699
+ EndUserBoundsChangingEvent,
18700
+ HotkeyEvent_2 as HotkeyEvent,
18701
+ WindowHotkeyEvent,
18702
+ InitializedEvent_2 as InitializedEvent,
18703
+ WindowInitializedEvent,
18704
+ MaximizedEvent,
18705
+ MinimizedEvent,
18706
+ PreloadScriptsStateChangedEvent,
18707
+ PreloadScriptsStateChangingEvent,
18708
+ RestoredEvent,
18709
+ WindowRestoredEvent,
18710
+ ShowRequestedEvent,
18711
+ WindowShowRequestedEvent,
18712
+ ShownEvent_2 as ShownEvent,
18713
+ WindowShownEvent,
18714
+ UserMovementEnabledEvent,
18715
+ UserMovementDisabledEvent,
18716
+ WillMoveEvent,
18717
+ WillResizeEvent,
18718
+ NonPropagatedWindowEvent,
18719
+ ShowAllDownloadsEvent,
18720
+ DownloadShelfVisibilityChangedEvent,
18721
+ WindowSourcedEvent,
18722
+ WillPropagateWindowEvent,
18723
+ Event_6 as Event,
18724
+ WindowEvent,
18725
+ EventType_2 as EventType,
18726
+ WindowEventType,
18727
+ PropagatedEvent_3 as PropagatedEvent,
18728
+ PropagatedWindowEvent,
18729
+ PropagatedWindowEventType,
18730
+ Payload_3 as Payload,
18731
+ ByType_2 as ByType
18732
+ }
18733
+ }
18734
+
18735
+ /**
18736
+ * @deprecated Renamed to {@link EventType}.
18737
+ */
18738
+ declare type WindowEventType = WindowEvent['type'];
18739
+
18740
+ /**
18741
+ * @deprecated Renamed to {@link HiddenEvent}.
18742
+ */
18743
+ declare type WindowHiddenEvent = HiddenEvent_2;
18744
+
18745
+ /**
18746
+ * @deprecated Renamed to {@link HotkeyEvent}.
18747
+ */
18748
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18749
+
18750
+ /**
18751
+ * @interface
18752
+ */
18753
+ declare type WindowInfo = {
18754
+ canNavigateBack: boolean;
18755
+ canNavigateForward: boolean;
18756
+ preloadScripts: Array<any>;
18757
+ title: string;
18758
+ url: string;
18759
+ };
18760
+
18761
+ /**
18762
+ * @deprecated Renamed to {@link InitializedEvent}.
18763
+ */
18764
+ declare type WindowInitializedEvent = InitializedEvent_2;
18765
+
18766
+ /**
18767
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18768
+ */
18769
+ declare class _WindowModule extends Base {
18770
+ /**
18771
+ * Asynchronously returns a Window object that represents an existing window.
18772
+ *
18773
+ * @example
18774
+ * ```js
18775
+ * async function createWin() {
18776
+ * const app = await fin.Application.start({
18777
+ * name: 'myApp',
18778
+ * uuid: 'app-1',
18779
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18780
+ * autoShow: true
18781
+ * });
18782
+ * return await app.getWindow();
18783
+ * }
18784
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18785
+ * .then(win => console.log('wrapped window'))
18786
+ * .catch(err => console.log(err));
18787
+ * ```
18788
+ */
18789
+ wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
18790
+ /**
18791
+ * Synchronously returns a Window object that represents an existing window.
18792
+ *
18793
+ * @example
18794
+ * ```js
18795
+ * async function createWin() {
18796
+ * const app = await fin.Application.start({
18797
+ * name: 'myApp',
18798
+ * uuid: 'app-1',
18799
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18800
+ * autoShow: true
18801
+ * });
18802
+ * return await app.getWindow();
18803
+ * }
18804
+ * await createWin();
18805
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18806
+ * ```
18807
+ */
18808
+ wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
18809
+ /**
18810
+ * Creates a new Window.
18811
+ * @param options - Window creation options
18812
+ *
18813
+ * @example
18814
+ * ```js
18815
+ * async function createWindow() {
18816
+ * const winOption = {
18817
+ * name:'child',
18818
+ * defaultWidth: 300,
18819
+ * defaultHeight: 300,
18820
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18821
+ * frame: true,
18822
+ * autoShow: true
18823
+ * };
18824
+ * return await fin.Window.create(winOption);
18825
+ * }
18826
+ *
18827
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18828
+ * ```
18829
+ */
18830
+ create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
18831
+ /**
18832
+ * Asynchronously returns a Window object that represents the current window
18833
+ *
18834
+ * @example
18835
+ * ```js
18836
+ * fin.Window.getCurrent()
18837
+ * .then(wnd => console.log('current window'))
18838
+ * .catch(err => console.log(err));
18839
+ *
18840
+ * ```
18841
+ */
18842
+ getCurrent(): Promise<OpenFin_2.Window>;
18843
+ /**
18844
+ * Synchronously returns a Window object that represents the current window
18845
+ *
18846
+ * @example
18847
+ * ```js
18848
+ * const wnd = fin.Window.getCurrentSync();
18849
+ * const info = await wnd.getInfo();
18850
+ * console.log(info);
18851
+ *
18852
+ * ```
18853
+ */
18854
+ getCurrentSync(): OpenFin_2.Window;
18855
+ }
18856
+
18857
+ /**
18858
+ * Generated when a child window is not responding.
18859
+ * @interface
18860
+ */
18861
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18862
+ type: 'window-not-responding';
18863
+ };
18864
+
18865
+ /**
18866
+ * @interface
18867
+ */
18868
+ declare type WindowOptionDiff = {
18869
+ [key in keyof WindowOptions]: {
18870
+ oldVal: WindowOptions[key];
18871
+ newVal: WindowOptions[key];
18872
+ };
18873
+ };
18874
+
18875
+ /**
18876
+ * @interface
18877
+ */
18878
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18879
+
18880
+ declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
18881
+
18882
+ /**
18883
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18884
+ */
18885
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18886
+
18887
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18888
+
18889
+ /**
18890
+ * Generated when a child window is responding.
18891
+ * @interface
18892
+ */
18893
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18894
+ type: 'window-responding';
18895
+ };
18896
+
18897
+ /**
18898
+ * @deprecated Renamed to {@link RestoredEvent}.
18899
+ */
18900
+ declare type WindowRestoredEvent = RestoredEvent;
18901
+
18902
+ /**
18903
+ * @deprecated Renamed to {@link ShownEvent}.
18904
+ */
18905
+ declare type WindowShownEvent = ShownEvent_2;
18906
+
18907
+ /**
18908
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18909
+ */
18910
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18911
+
18912
+ /**
18913
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18914
+ * from {@link OpenFin.ViewEvents}.
18915
+ */
18916
+ 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;
18917
+
18918
+ /**
18919
+ * Generated when a child window starts loading.
18920
+ * @interface
18921
+ */
18922
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18923
+ type: 'window-start-load';
18924
+ };
18925
+
18926
+ /**
18927
+ * Visibility state of a window.
18928
+ */
18929
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18930
+
18931
+ /**
18932
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18933
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18934
+ */
18935
+ declare type WindowViewEvent = {
18936
+ viewIdentity: OpenFin_2.Identity;
18937
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18938
+
18939
+ /**
18940
+ * @interface
18941
+ */
18942
+ declare type WindowViewsPrintOptions = {
18943
+ content: 'views';
18944
+ includeSelf?: boolean;
18945
+ };
18946
+
18947
+ declare type Wire = EventEmitter & {
18948
+ connect(messageReciever: MessageReceiver): Promise<any>;
18949
+ connectSync(): any;
18950
+ send(data: any): Promise<any>;
18951
+ shutdown(): Promise<void>;
18952
+ getPort(): string;
18953
+ };
18954
+
18955
+ declare type WireConstructor = {
18956
+ new (onmessage: (data: any) => void): Wire;
18957
+ };
18958
+
18959
+ /**
18960
+ * @internal
18961
+ */
18962
+ declare type WithId<T extends AppVersionEventType> = `${T}.${string}`;
18963
+
18964
+ declare interface WithInterop {
18965
+ interop: InteropClient;
18966
+ }
18967
+
18968
+ /**
18969
+ * @internal
18970
+ */
18971
+ declare type WithoutId<T extends string> = T extends WithId<infer U> ? U : never;
18972
+
18973
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18974
+ positioningOptions?: OpenFin_2.PositioningOptions;
18975
+ };
18976
+
18977
+ /**
18978
+ * @internal
18979
+ * @interface
18980
+ */
18981
+ declare type WorkspacePlatformOptions = {
18982
+ /** Leaving this as any for now until we figure out what the shape should look like in Workspace */
18983
+ [key: string]: any;
18984
+ };
18985
+
18986
+ /**
18987
+ * A generic request to write any supported data to the clipboard.
18988
+ * @interface
18989
+ */
18990
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18991
+ /**
18992
+ * Data to be written
18993
+ */
18994
+ data: {
18995
+ text?: string;
18996
+ html?: string;
18997
+ rtf?: string;
18998
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18999
+ };
19000
+
19001
+ /**
19002
+ * @deprecated - instead use WriteAnyClipboardRequest
19003
+ *
19004
+ * A generic request to write any supported data to the clipboard.
19005
+ *
19006
+ * @interface
19007
+ */
19008
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19009
+
19010
+ /**
19011
+ * A request to write data to the clipboard.
19012
+ * @interface
19013
+ */
19014
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
19015
+ /**
19016
+ * Data to write to the clipboard.
19017
+ */
19018
+ data: string;
19019
+ };
19020
+
19021
+ /**
19022
+ * @interface
19023
+ */
19024
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19025
+ /**
19026
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
19027
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19028
+ * Using other image/<format> DataURLs will throw an Error.
19029
+ */
19030
+ image: string;
19031
+ };
19032
+
19033
+ /**
19034
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
19035
+ *
19036
+ * A request to write data to the clipboard.
19037
+ *
19038
+ * @interface
19039
+ */
19040
+ declare type WriteRequestType = WriteClipboardRequest;
19041
+
19042
+ export { }