@openfin/core 35.78.16 → 35.78.18

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.
@@ -189,100 +189,6 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
189
189
  private window;
190
190
  /* Excluded from this release type: __constructor */
191
191
  private windowListFromIdentityList;
192
- /**
193
- * Adds a listener to the end of the listeners array for the specified event.
194
- * @param eventType - The type of the event.
195
- * @param listener - Called whenever an event of the specified type occurs.
196
- * @param options - Option to support event timestamps.
197
- *
198
- * @function addListener
199
- * @memberof Application
200
- * @instance
201
- * @tutorial Application.EventEmitter
202
- */
203
- /**
204
- * Adds a listener to the end of the listeners array for the specified event.
205
- * @param eventType - The type of the event.
206
- * @param listener - Called whenever an event of the specified type occurs.
207
- * @param options - Option to support event timestamps.
208
- *
209
- * @function on
210
- * @memberof Application
211
- * @instance
212
- * @tutorial Application.EventEmitter
213
- */
214
- /**
215
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
216
- * @param eventType - The type of the event.
217
- * @param listener - The callback function.
218
- * @param options - Option to support event timestamps.
219
- *
220
- * @function once
221
- * @memberof Application
222
- * @instance
223
- * @tutorial Application.EventEmitter
224
- */
225
- /**
226
- * Adds a listener to the beginning of the listeners array for the specified event.
227
- * @param eventType - The type of the event.
228
- * @param listener - The callback function.
229
- * @param options - Option to support event timestamps.
230
- *
231
- * @function prependListener
232
- * @memberof Application
233
- * @instance
234
- * @tutorial Application.EventEmitter
235
- */
236
- /**
237
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
238
- * The listener is added to the beginning of the listeners array.
239
- * @param eventType - The type of the event.
240
- * @param listener - The callback function.
241
- * @param options - Option to support event timestamps.
242
- *
243
- * @function prependOnceListener
244
- * @memberof Application
245
- * @instance
246
- * @tutorial Application.EventEmitter
247
- */
248
- /**
249
- * Remove a listener from the listener array for the specified event.
250
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
251
- * @param eventType - The type of the event.
252
- * @param listener - The callback function.
253
- * @param options - Option to support event timestamps.
254
- *
255
- * @function removeListener
256
- * @memberof Application
257
- * @instance
258
- * @tutorial Application.EventEmitter
259
- */
260
- /**
261
- * Removes all listeners, or those of the specified event.
262
- * @param eventType - The type of the event.
263
- *
264
- * @function removeAllListeners
265
- * @memberof Application
266
- * @instance
267
- * @tutorial Application.EventEmitter
268
- */
269
- /**
270
- * JumpListCategory interface
271
- * @typedef { object } JumpListCategory@typedef { object } JumpListCategory
272
- * @property { string } name The display title for the category. If omitted, items in this category will be placed into the standard 'Tasks' category. There can be only one such category, and it will always be displayed at the bottom of the JumpList.
273
- * @property { JumpListItem[] } items Array of JumpListItem objects
274
- */
275
- /**
276
- * @PORTED
277
- * JumpListItem interface
278
- * @typedef { object } JumpListItem@typedef { object } JumpListItem
279
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
280
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
281
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
282
- * @property { string } deepLink Deep link to a manifest, i.e: fins://path.to/manifest.json?$$param1=value1. See {@link https://developers.openfin.co/docs/deep-linking deep-linking} for more information.
283
- * @property { string } iconPath The absolute path to an icon to be displayed for the item, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll).
284
- * @property { number } iconIndex The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
285
- */
286
192
  /**
287
193
  * Determines if the application is currently running.
288
194
  *
@@ -3110,20 +3016,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3110
3016
  connectionUrl: string;
3111
3017
  };
3112
3018
 
3113
- /**
3114
- * @PORTED
3115
- * WriteRequestType interface
3116
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3117
- * @property { string } data Data to be written
3118
- * @property { string } [type] Clipboard Type
3119
- */
3120
- /**
3121
- * @PORTED
3122
- * OpenFin.WriteAnyClipboardRequest interface
3123
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3124
- * @property { string } data Data to be written
3125
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3126
- */
3127
3019
  /**
3128
3020
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3129
3021
  *
@@ -5327,83 +5219,6 @@ declare type ExitCode = {
5327
5219
  declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicationEvent> {
5328
5220
  identity: OpenFin_2.ApplicationIdentity;
5329
5221
  /* Excluded from this release type: __constructor */
5330
- /**
5331
- * Adds a listener to the end of the listeners array for the specified event.
5332
- * @param eventType - The type of the event.
5333
- * @param listener - Called whenever an event of the specified type occurs.
5334
- * @param options - Option to support event timestamps.
5335
- *
5336
- * @function addListener
5337
- * @memberof ExternalApplication
5338
- * @instance
5339
- * @tutorial ExternalApplication.EventEmitter
5340
- */
5341
- /**
5342
- * Adds a listener to the end of the listeners array for the specified event.
5343
- * @param eventType - The type of the event.
5344
- * @param listener - Called whenever an event of the specified type occurs.
5345
- * @param options - Option to support event timestamps.
5346
- *
5347
- * @function on
5348
- * @memberof ExternalApplication
5349
- * @instance
5350
- * @tutorial ExternalApplication.EventEmitter
5351
- */
5352
- /**
5353
- * 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.
5354
- * @param eventType - The type of the event.
5355
- * @param listener - The callback function.
5356
- * @param options - Option to support event timestamps.
5357
- *
5358
- * @function once
5359
- * @memberof ExternalApplication
5360
- * @instance
5361
- * @tutorial ExternalApplication.EventEmitter
5362
- */
5363
- /**
5364
- * Adds a listener to the beginning of the listeners array for the specified event.
5365
- * @param eventType - The type of the event.
5366
- * @param listener - The callback function.
5367
- * @param options - Option to support event timestamps.
5368
- *
5369
- * @function prependListener
5370
- * @memberof ExternalApplication
5371
- * @instance
5372
- * @tutorial ExternalApplication.EventEmitter
5373
- */
5374
- /**
5375
- * Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.
5376
- * The listener is added to the beginning of the listeners array.
5377
- * @param eventType - The type of the event.
5378
- * @param listener - The callback function.
5379
- * @param options - Option to support event timestamps.
5380
- *
5381
- * @function prependOnceListener
5382
- * @memberof ExternalApplication
5383
- * @instance
5384
- * @tutorial ExternalApplication.EventEmitter
5385
- */
5386
- /**
5387
- * Remove a listener from the listener array for the specified event.
5388
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5389
- * @param eventType - The type of the event.
5390
- * @param listener - The callback function.
5391
- * @param options - Option to support event timestamps.
5392
- *
5393
- * @function removeListener
5394
- * @memberof ExternalApplication
5395
- * @instance
5396
- * @tutorial ExternalApplication.EventEmitter
5397
- */
5398
- /**
5399
- * Removes all listeners, or those of the specified event.
5400
- * @param eventType - The type of the event.
5401
- *
5402
- * @function removeAllListeners
5403
- * @memberof ExternalApplication
5404
- * @instance
5405
- * @tutorial ExternalApplication.EventEmitter
5406
- */
5407
5222
  /**
5408
5223
  * Retrieves information about the external application.
5409
5224
  *
@@ -5819,83 +5634,6 @@ declare type FoundInPageEvent = NamedEvent & {
5819
5634
  declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5820
5635
  identity: OpenFin_2.Identity;
5821
5636
  /* Excluded from this release type: __constructor */
5822
- /**
5823
- * Adds the listener function to the end of the listeners array for the specified event type.
5824
- * @param eventType - The type of the event.
5825
- * @param listener - Called whenever an event of the specified type occurs.
5826
- * @param options - Option to support event timestamps.
5827
- *
5828
- * @function addListener
5829
- * @memberof Frame
5830
- * @instance
5831
- * @tutorial Frame.EventEmitter
5832
- */
5833
- /**
5834
- * Adds a listener to the end of the listeners array for the specified event.
5835
- * @param eventType - The type of the event.
5836
- * @param listener - Called whenever an event of the specified type occurs.
5837
- * @param options - Option to support event timestamps.
5838
- *
5839
- * @function on
5840
- * @memberof Frame
5841
- * @instance
5842
- * @tutorial Frame.EventEmitter
5843
- */
5844
- /**
5845
- * 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.
5846
- * @param eventType - The type of the event.
5847
- * @param listener - The callback function.
5848
- * @param options - Option to support event timestamps.
5849
- *
5850
- * @function once
5851
- * @memberof Frame
5852
- * @instance
5853
- * @tutorial Frame.EventEmitter
5854
- */
5855
- /**
5856
- * Adds a listener to the beginning of the listeners array for the specified event.
5857
- * @param eventType - The type of the event.
5858
- * @param listener - The callback function.
5859
- * @param options - Option to support event timestamps.
5860
- *
5861
- * @function prependListener
5862
- * @memberof Frame
5863
- * @instance
5864
- * @tutorial Frame.EventEmitter
5865
- */
5866
- /**
5867
- * 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.
5868
- * The listener is added to the beginning of the listeners array.
5869
- * @param eventType - The type of the event.
5870
- * @param listener - The callback function.
5871
- * @param options - Option to support event timestamps.
5872
- *
5873
- * @function prependOnceListener
5874
- * @memberof Frame
5875
- * @instance
5876
- * @tutorial Frame.EventEmitter
5877
- */
5878
- /**
5879
- * Remove a listener from the listener array for the specified event.
5880
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5881
- * @param eventType - The type of the event.
5882
- * @param listener - The callback function.
5883
- * @param options - Option to support event timestamps.
5884
- *
5885
- * @function removeListener
5886
- * @memberof Frame
5887
- * @instance
5888
- * @tutorial Frame.EventEmitter
5889
- */
5890
- /**
5891
- * Removes all listeners, or those of the specified event.
5892
- * @param eventType - The type of the event.
5893
- *
5894
- * @function removeAllListeners
5895
- * @memberof Frame
5896
- * @instance
5897
- * @tutorial Frame.EventEmitter
5898
- */
5899
5637
  /**
5900
5638
  * Returns a frame info object for the represented frame.
5901
5639
  *
@@ -7158,56 +6896,6 @@ declare class InteropBroker extends Base {
7158
6896
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7159
6897
  new (): InteropBroker;
7160
6898
  };
7161
- /**
7162
- * @REMOVED
7163
- * SetContextOptions interface
7164
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
7165
- * @property { Context } {context} - New context to set.
7166
- */
7167
- /**
7168
- * @REMOVED
7169
- * GetContextOptions interface
7170
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
7171
- * @property { string } [contextType] - Context Type
7172
- */
7173
- /**
7174
- * @REMOVED
7175
- * JoinContextGroupOptions interface
7176
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
7177
- * @property { string } contextGroupId - Id of the context group.
7178
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
7179
- */
7180
- /**
7181
- * @REMOVED
7182
- * AddClientToContextGroupOptions interface
7183
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
7184
- * @property { string } contextGroupId - Name of the context group.
7185
- */
7186
- /**
7187
- * @REMOVED
7188
- * RemoveFromContextGroupOptions interface
7189
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
7190
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
7191
- */
7192
- /**
7193
- * @REMOVED
7194
- * GetInfoForContextGroupOptions interface
7195
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
7196
- * @property { string } contextGroupId - Name of the context group to get info for.
7197
- */
7198
- /**
7199
- * @REMOVED
7200
- * GetAllClientsInContextGroupOptions interface
7201
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
7202
- * @property { string } contextGroupId - Name of the context group to get info for.
7203
- */
7204
- /**
7205
- * @PORTED
7206
- * InfoForIntentOptions interface
7207
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
7208
- * @property { string } name Name of the intent to get info for.
7209
- * @property { Context } [context] Optional context.
7210
- */
7211
6899
  /**
7212
6900
  * Sets a context for the context group of the incoming current entity.
7213
6901
  * @param setContextOptions - New context to set.
@@ -7707,95 +7395,6 @@ declare type InteropBrokerOptions = {
7707
7395
  logging?: InteropLoggingOptions;
7708
7396
  };
7709
7397
 
7710
- /**
7711
- * @PORTED
7712
- * @typedef { object } Intent
7713
- * @summary The combination of an action and a context that is passed to an application for resolution.
7714
- * @property { string } name Name of the intent.
7715
- * @property { Context } context Data associated with the intent
7716
- */
7717
- /**
7718
- * @REMOVED
7719
- * @typedef { object } Subscription
7720
- * @summary Object returned when subscribing a handler.
7721
- * @property { function } unsubscribe Function to unsubscribe the handler.
7722
- */
7723
- /**
7724
- * @typedef { function } ContextHandler
7725
- * @summary Subscription function for addContextHandler.
7726
- */
7727
- /**
7728
- * @typedef { function } IntentHandler
7729
- * @summary Subscription function for registerIntentHandler
7730
- */
7731
- /**
7732
- * @PORTED
7733
- * @typedef { object } ClientIdentity
7734
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7735
- * @property {string} uuid GUID of an application.
7736
- * @property {string} name Name of an entity in an application.
7737
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7738
- */
7739
- /**
7740
- * @PORTED
7741
- * @typedef { object } ContextGroupInfo
7742
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7743
- * @property {string} id Name of the context group
7744
- * @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.
7745
- */
7746
- /**
7747
- * @PORTED
7748
- * @typedef { object } DisplayMetadata
7749
- * @summary The display data for a Context Group.
7750
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7751
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7752
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7753
- */
7754
- /**
7755
- * @PORTED
7756
- * @typedef { object } Context
7757
- * @summary Data passed between entities and applications.
7758
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7759
- * @property {string} [name] User-readable name for the incoming context.
7760
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7761
- */
7762
- /**
7763
- * @REMOVED
7764
- * @typedef { object } ContextForIntent
7765
- * @summary Data passed between entities and applications, including an optional metadata.
7766
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7767
- * @property {string} [name] User-readable name for the incoming context.
7768
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7769
- * @property {any} [metadata]
7770
- */
7771
- /**
7772
- * @REMOVED
7773
- * @typedef { object } SessionContextGroup
7774
- * @summary An instance of a SessionContextGroup
7775
- * @property {string} id The SessionContextGroup's id.
7776
- * @property {setContext} setContext Sets a context of a certain type
7777
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7778
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7779
- */
7780
- /**
7781
- * @typedef {function} setContext
7782
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7783
- * @param context The Context to be set.
7784
- *
7785
- */
7786
- /**
7787
- * @typedef {function} getCurrentContext
7788
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7789
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7790
- *
7791
- */
7792
- /**
7793
- * @typedef {function} addContextHandler
7794
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7795
- * @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.
7796
- * @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.
7797
- *
7798
- */
7799
7398
  /**
7800
7399
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7801
7400
  *
@@ -8231,13 +7830,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8231
7830
  */
8232
7831
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8233
7832
 
8234
- /**
8235
- * @PORTED
8236
- * @typedef { object } InteropConfig
8237
- * @summary Information relevant to the Interop Broker.
8238
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
8239
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
8240
- */
8241
7833
  /**
8242
7834
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8243
7835
  *
@@ -8847,7 +8439,8 @@ declare type LayoutIdentity = Identity_5 & {
8847
8439
  };
8848
8440
 
8849
8441
  /**
8850
- * Generated when the window and all of its layout's views have either finished or failed navigation, once per layout.
8442
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8443
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8851
8444
  * @interface
8852
8445
  */
8853
8446
  declare type LayoutInitializedEvent = BaseEvent_5 & {
@@ -11422,6 +11015,17 @@ declare interface PlatformProvider {
11422
11015
  */
11423
11016
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11424
11017
  /* Excluded from this release type: getInitialLayoutSnapshot */
11018
+ /**
11019
+ * @experimental
11020
+ *
11021
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11022
+ * Get's the current state of a particular window and its views and returns an object that
11023
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11024
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11025
+ * @param identity
11026
+ * @param callerIdentity
11027
+ */
11028
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11425
11029
  /* Excluded from this release type: createViewsForLayout */
11426
11030
  /* Excluded from this release type: getViewSnapshot */
11427
11031
  /**
@@ -13681,83 +13285,6 @@ declare type SubscriptionOptions = {
13681
13285
  declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
13682
13286
  /* Excluded from this release type: __constructor */
13683
13287
  private sendExternalProcessRequest;
13684
- /**
13685
- * Adds a listener to the end of the listeners array for the specified event.
13686
- * @param eventType - The type of the event.
13687
- * @param listener - Called whenever an event of the specified type occurs.
13688
- * @param options - Option to support event timestamps.
13689
- *
13690
- * @function addListener
13691
- * @memberof System
13692
- * @instance
13693
- * @tutorial System.EventEmitter
13694
- */
13695
- /**
13696
- * Adds a listener to the end of the listeners array for the specified event.
13697
- * @param eventType - The type of the event.
13698
- * @param listener - Called whenever an event of the specified type occurs.
13699
- * @param options - Option to support event timestamps.
13700
- *
13701
- * @function on
13702
- * @memberof System
13703
- * @instance
13704
- * @tutorial System.EventEmitter
13705
- */
13706
- /**
13707
- * 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.
13708
- * @param eventType - The type of the event.
13709
- * @param listener - The callback function.
13710
- * @param options - Option to support event timestamps.
13711
- *
13712
- * @function once
13713
- * @memberof System
13714
- * @instance
13715
- * @tutorial System.EventEmitter
13716
- */
13717
- /**
13718
- * Adds a listener to the beginning of the listeners array for the specified event.
13719
- * @param eventType - The type of the event.
13720
- * @param listener - The callback function.
13721
- * @param options - Option to support event timestamps.
13722
- *
13723
- * @function prependListener
13724
- * @memberof System
13725
- * @instance
13726
- * @tutorial System.EventEmitter
13727
- */
13728
- /**
13729
- * 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.
13730
- * The listener is added to the beginning of the listeners array.
13731
- * @param eventType - The type of the event.
13732
- * @param listener - The callback function.
13733
- * @param options - Option to support event timestamps.
13734
- *
13735
- * @function prependOnceListener
13736
- * @memberof System
13737
- * @instance
13738
- * @tutorial System.EventEmitter
13739
- */
13740
- /**
13741
- * Remove a listener from the listener array for the specified event.
13742
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
13743
- * @param eventType - The type of the event.
13744
- * @param listener - The callback function.
13745
- * @param options - Option to support event timestamps.
13746
- *
13747
- * @function removeListener
13748
- * @memberof System
13749
- * @instance
13750
- * @tutorial System.EventEmitter
13751
- */
13752
- /**
13753
- * Removes all listeners, or those of the specified event.
13754
- * @param eventType - The type of the event.
13755
- *
13756
- * @function removeAllListeners
13757
- * @memberof System
13758
- * @instance
13759
- * @tutorial System.EventEmitter
13760
- */
13761
13288
  /**
13762
13289
  * Returns the version of the runtime. The version contains the major, minor,
13763
13290
  * build and revision numbers.
@@ -15785,169 +15312,6 @@ declare type VerboseWebPermission = {
15785
15312
 
15786
15313
  declare type View = OpenFin_2.View;
15787
15314
 
15788
- /**
15789
- * @PORTED
15790
- * @typedef {object} View~options
15791
- * @summary View creation options.
15792
- * @desc This is the options object required by {@link View.create View.create}.
15793
- *
15794
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
15795
- * (defaults to `"about:blank"` when omitted).
15796
- *
15797
- * @property {object} [experimental]
15798
- * Configurations for API injection.
15799
- *
15800
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
15801
- *
15802
- * @property {object} [accelerator]
15803
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
15804
- *
15805
- * @property {boolean} [accelerator.devtools=false]
15806
- * If `true`, enables the devtools keyboard shortcut:<br>
15807
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
15808
- *
15809
- * @property {boolean} [accelerator.reload=false]
15810
- * If `true`, enables the reload keyboard shortcuts:<br>
15811
- * `Ctrl` + `R` _(Windows)_<br>
15812
- * `F5` _(Windows)_<br>
15813
- * `Command` + `R` _(Mac)_
15814
- *
15815
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
15816
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
15817
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
15818
- * `Shift` + `F5` _(Windows)_<br>
15819
- * `Command` + `Shift` + `R` _(Mac)_
15820
- *
15821
- * @property {boolean} [accelerator.zoom=false]
15822
- * If `true`, enables the zoom keyboard shortcuts:<br>
15823
- * `Ctrl` + `+` _(Zoom In)_<br>
15824
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
15825
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
15826
- * `Ctrl` + `-` _(Zoom Out)_<br>
15827
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
15828
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
15829
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
15830
- * `Ctrl` + `0` _(Restore to 100%)_
15831
- *
15832
- * @property {object} [api]
15833
- * Configurations for API injection.
15834
- *
15835
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
15836
- *
15837
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
15838
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
15839
- *
15840
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
15841
- * Autoplay policy to apply to content in the window, can be
15842
- * `no-user-gesture-required`, `user-gesture-required`,
15843
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
15844
- *
15845
- * @property {object} [autoResize] AutoResize options
15846
- *
15847
- * @property {object} [bounds] initial bounds given relative to the window.
15848
- *
15849
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
15850
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
15851
- * (`document.body.style.backgroundColor`),
15852
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
15853
- * areas when growing a window. Setting
15854
- * this value to the anticipated content background color can help improve user experience.
15855
- * Default is white.
15856
- *
15857
- * @property {object} [contentNavigation]
15858
- * Restrict navigation to URLs that match an allowed pattern.
15859
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
15860
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15861
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
15862
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
15863
- *
15864
- * @property {object} [contentRedirect]
15865
- * Restrict redirects to URLs that match an allowed pattern.
15866
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
15867
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15868
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
15869
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
15870
- *
15871
- * @property {object} [contextMenuSettings] - _Updatable._
15872
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
15873
- * Configure the context menu when right-clicking on a view.
15874
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
15875
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
15876
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
15877
- *
15878
- * @property {object} [contextMenuOptions] - _Updatable._
15879
- * Configure the context menu when right-clicking on a view. Supported menu items:
15880
- * 'separator'
15881
- * 'cut'
15882
- * 'copy'
15883
- * 'copyImage',
15884
- * 'paste'
15885
- * 'spellCheck'
15886
- * 'inspect'
15887
- * 'reload'
15888
- * 'navigateForward'
15889
- * 'navigateBack'
15890
- * 'print'
15891
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
15892
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
15893
- *
15894
- * @property {any} [customData=""] - _Updatable._
15895
- * A field that the user can attach serializable data to be ferried around with the view options.
15896
- * _When omitted, the default value of this property is the empty string (`""`)._
15897
- *
15898
- * @property {any} [customContext=""] - _Updatable._
15899
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
15900
- * is called.
15901
- * When omitted, the default value of this property is the empty string (`""`).
15902
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
15903
- *
15904
- * @property {object[]} [hotkeys=[]] - _Updatable._
15905
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
15906
- * Within Platform, OpenFin also implements a set of pre-defined actions called
15907
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
15908
- * that can be assigned to a specific hotkey in the platform manifest.
15909
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
15910
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
15911
- *
15912
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
15913
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
15914
- * if the view isn't part of the new layout when running `Layout.replace`.
15915
- *
15916
- * @property {string} name
15917
- * The name of the view.
15918
- *
15919
- * @property {boolean} [detachOnClose=false] - _Updatable._
15920
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
15921
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
15922
- *
15923
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
15924
- * but the properties in the manifest will take precedence if there is any collision.
15925
- *
15926
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
15927
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
15928
- * from the parent application.
15929
- *
15930
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
15931
- *
15932
- * @property {string} [processAffinity=<application uuid>]
15933
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
15934
- *
15935
- * @property {boolean} [spellCheck=false]
15936
- * Enable spell check in input text fields for the view.
15937
- *
15938
- * @property {Identity} [target]
15939
- * The identity of the window this view should be attached to.
15940
- *
15941
- * @property {string} [url="about:blank"]
15942
- * The URL of the view.
15943
- *
15944
- * @property {string} [uuid=<application uuid>]
15945
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
15946
- * If omitted, defaults to the `uuid` of the application spawning the view.
15947
- * If given, must match the `uuid` of the application spawning the view.
15948
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
15949
- * really no need to provide it.
15950
- */
15951
15315
  /**
15952
15316
  * A View can be used to embed additional web content into a Window.
15953
15317
  * It is like a child window, except it is positioned relative to its owning window.
@@ -17740,476 +17104,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17740
17104
  type: 'will-resize';
17741
17105
  };
17742
17106
 
17743
- /**
17744
- * @PORTED
17745
- * @typedef { object } Margins@typedef { object } Margins
17746
- * @property { string } [marginType]
17747
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
17748
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
17749
- *
17750
- * @property { number } [top] The top margin of the printed web page, in pixels.
17751
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
17752
- * @property { number } [left] The left margin of the printed web page, in pixels.
17753
- * @property { number } [right] The right margin of the printed web page, in pixels.
17754
- */
17755
- /**
17756
- * @PORTED
17757
- * @typedef { object } Dpi@typedef { object } Dpi
17758
- * @property { number } [horizontal] The horizontal dpi
17759
- * @property { number } [vertical] The vertical dpi
17760
- */
17761
- /**
17762
- * @PORTED
17763
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
17764
- * @property { boolean } [silent=false] Don't ask user for print settings.
17765
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
17766
- * @property { string } [deviceName=''] Set the printer device name to use.
17767
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
17768
- * @property { Margins } [margins] Set margins for the printed web page
17769
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
17770
- * @property { number } [scaleFactor] The scale factor of the web page.
17771
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
17772
- * @property { boolean } [collate] Whether the web page should be collated.
17773
- * @property { number } [copies] The number of copies of the web page to print.
17774
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
17775
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
17776
- * @property { Dpi } [dpi] Set dpi for the printed web page
17777
- */
17778
- /**
17779
- * @REMOVED
17780
- * PrinterInfo interface
17781
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
17782
- * @property { string } name Printer Name
17783
- * @property { string } description Printer Description
17784
- * @property { number } status Printer Status
17785
- * @property { boolean } isDefault Indicates that system's default printer
17786
- */
17787
- /**
17788
- * @REMOVED
17789
- * SharedWorkerInfo interface
17790
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
17791
- * @property { string } id The unique id of the shared worker.
17792
- * @property { string } url The url of the shared worker.
17793
- */
17794
- /**
17795
- * @PORTED
17796
- * ContentCreationRule interface
17797
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
17798
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
17799
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
17800
- * @property { object } options Window creation options or View creation options.
17801
- */
17802
- /**
17803
- * @PORTED
17804
- * @typedef {object} Window~options
17805
- * @summary Window creation options.
17806
- * @desc This is the options object required by {@link Window.create Window.create}.
17807
- *
17808
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
17809
- * (defaults to `"about:blank"` when omitted).
17810
- *
17811
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
17812
- *
17813
- * @property {object} [accelerator]
17814
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
17815
- *
17816
- * @property {boolean} [accelerator.devtools=false]
17817
- * If `true`, enables the devtools keyboard shortcut:<br>
17818
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
17819
- *
17820
- * @property {boolean} [accelerator.reload=false]
17821
- * If `true`, enables the reload keyboard shortcuts:<br>
17822
- * `Ctrl` + `R` _(Windows)_<br>
17823
- * `F5` _(Windows)_<br>
17824
- * `Command` + `R` _(Mac)_
17825
- *
17826
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
17827
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
17828
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
17829
- * `Shift` + `F5` _(Windows)_<br>
17830
- * `Command` + `Shift` + `R` _(Mac)_
17831
- *
17832
- * @property {boolean} [accelerator.zoom=false]
17833
- * 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.
17834
- * If `true`, enables the zoom keyboard shortcuts:<br>
17835
- * `Ctrl` + `+` _(Zoom In)_<br>
17836
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
17837
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
17838
- * `Ctrl` + `-` _(Zoom Out)_<br>
17839
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
17840
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
17841
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
17842
- * `Ctrl` + `0` _(Restore to 100%)_
17843
- *
17844
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
17845
- * <br>
17846
- * alphaMask turns anything of matching RGB value transparent.
17847
- * <br>
17848
- * Caveats:
17849
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
17850
- * * User cannot click-through transparent regions
17851
- * * Not supported on Mac
17852
- * * Windows Aero must be enabled
17853
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
17854
- * * Not supported on rounded corner windows
17855
- * @property {number} [alphaMask.red=-1] 0-255
17856
- * @property {number} [alphaMask.green=-1] 0-255
17857
- * @property {number} [alphaMask.blue=-1] 0-255
17858
- *
17859
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
17860
- * A flag to always position the window at the top of the window stack.
17861
- *
17862
- * @property {object} [api]
17863
- * Configurations for API injection.
17864
- *
17865
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
17866
- *
17867
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
17868
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
17869
- *
17870
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
17871
- *
17872
- * @property {number} [aspectRatio=0] - _Updatable._
17873
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
17874
- * an aspect ratio will not be enforced.
17875
- *
17876
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
17877
- * Autoplay policy to apply to content in the window, can be
17878
- * `no-user-gesture-required`, `user-gesture-required`,
17879
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
17880
- *
17881
- * @property {boolean} [autoShow=true]
17882
- * A flag to automatically show the window when it is created.
17883
- *
17884
- * @property {string} [backgroundColor="#FFF"]
17885
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
17886
- * (`document.body.style.backgroundColor`),
17887
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
17888
- * areas when growing a window. Setting
17889
- * this value to the anticipated content background color can help improve user experience.
17890
- * Default is white.
17891
- *
17892
- * @property {object} [contentCreation]
17893
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
17894
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
17895
- *
17896
- * @property {object} [contentNavigation]
17897
- * Restrict navigation to URLs that match an allowed pattern.
17898
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
17899
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17900
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
17901
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
17902
- *
17903
- * @property {object} [contentRedirect]
17904
- * Restrict redirects to URLs that match an allowed pattern.
17905
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
17906
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17907
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
17908
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
17909
- *
17910
- * @property {boolean} [contextMenu=true] - _Updatable._
17911
- * A flag to show the context menu when right-clicking on a window.
17912
- * Gives access to the devtools for the window.
17913
- *
17914
- * @property {object} [contextMenuSettings] - _Updatable._
17915
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
17916
- * Configure the context menu when right-clicking on a window.
17917
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
17918
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
17919
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
17920
- *
17921
- * @property {object} [contextMenuOptions] - _Updatable._
17922
- * Configure the context menu when right-clicking on a window. Supported menu items:
17923
- * 'separator'
17924
- * 'cut'
17925
- * 'copy'
17926
- * 'paste'
17927
- * 'spellCheck'
17928
- * 'inspect'
17929
- * 'reload'
17930
- * 'navigateForward'
17931
- * 'navigateBack'
17932
- * 'print'
17933
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
17934
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
17935
- *
17936
- * @property {object} [cornerRounding] - _Updatable._
17937
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
17938
- * average of _height_ and _width_.
17939
- * @property {number} [cornerRounding.height=0] The height in pixels.
17940
- * @property {number} [cornerRounding.width=0] The width in pixels.
17941
- *
17942
- * @property {any} [customContext=""] - _Updatable. Inheritable._
17943
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
17944
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
17945
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
17946
- * _When omitted, _inherits_ from the parent application._
17947
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
17948
- *
17949
- * @property {any} [customData=""] - _Updatable. Inheritable._
17950
- * A field that the user can attach serializable data to be ferried around with the window options.
17951
- * _When omitted, _inherits_ from the parent application._
17952
- *
17953
- * @property {object[]} [customRequestHeaders]
17954
- * Defines list of custom headers for requests sent by the window.
17955
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
17956
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
17957
- * where the object key is the name of header and value at key is the value of the header
17958
- *
17959
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
17960
- * Toggling off would keep the Window alive even if all its Views were closed.
17961
- * This is meant for advanced users and should be used with caution.
17962
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
17963
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
17964
- * ** note ** - This option is ignored in non-Platforms apps.
17965
- *
17966
- * @property {boolean} [defaultCentered=false]
17967
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
17968
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
17969
- * somewhat above center vertically.
17970
- *
17971
- * @property {number} [defaultHeight=500]
17972
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
17973
- * in favor of the cached value.
17974
- *
17975
- * @property {number} [defaultLeft=100]
17976
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17977
- * launches in favor of the cached value.
17978
- *
17979
- * @property {number} [defaultTop=100]
17980
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17981
- * launches in favor of the cached value.
17982
- *
17983
- * @property {number} [defaultWidth=800]
17984
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17985
- * launches in favor of the cached value.
17986
- *
17987
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
17988
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
17989
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
17990
- *
17991
- * @property {boolean} [frame=true] - _Updatable._
17992
- * A flag to show the frame.
17993
- *
17994
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
17995
- *
17996
- * @property {object[]} [hotkeys=[]] - _Updatable._
17997
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
17998
- * Within Platform, OpenFin also implements a set of pre-defined actions called
17999
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
18000
- * that can be assigned to a specific hotkey in the platform manifest.
18001
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
18002
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
18003
- *
18004
- * @property {string} [icon] - _Updatable. Inheritable._
18005
- * A URL for the icon to be shown in the window title bar and the taskbar.
18006
- * When omitted, inherits from the parent application._
18007
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
18008
- *
18009
- * @property {number} [maxHeight=-1] - _Updatable._
18010
- * The maximum height of a window. Will default to the OS defined value if set to -1.
18011
- *
18012
- * @property {boolean} [maximizable=true] - _Updatable._
18013
- * A flag that lets the window be maximized.
18014
- *
18015
- * @property {number} [maxWidth=-1] - _Updatable._
18016
- * The maximum width of a window. Will default to the OS defined value if set to -1.
18017
- *
18018
- * @property {number} [minHeight=0] - _Updatable._
18019
- * The minimum height of a window.
18020
- *
18021
- * @property {boolean} [minimizable=true] - _Updatable._
18022
- * A flag that lets the window be minimized.
18023
- *
18024
- * @property {number} [minWidth=0] - _Updatable._
18025
- * The minimum width of a window.
18026
- *
18027
- * @property {Identity} [modalParentIdentity]
18028
- * Parent identity of a modal window. It will create a modal child window when this option is set.
18029
- *
18030
- * @property {string} name
18031
- * The name of the window.
18032
- *
18033
- * @property {number} [opacity=1.0] - _Updatable._
18034
- * A flag that specifies how transparent the window will be.
18035
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
18036
- * This value is clamped between `0.0` and `1.0`.
18037
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
18038
- *
18039
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
18040
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
18041
- * from the parent application.
18042
- *
18043
- * @property {string} [processAffinity]
18044
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
18045
- *
18046
- * @property {boolean} [resizable=true] - _Updatable._
18047
- * A flag to allow the user to resize the window.
18048
- *
18049
- * @property {object} [resizeRegion] - _Updatable._
18050
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
18051
- * @property {number} [resizeRegion.bottomRightCorner=9]
18052
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
18053
- * @property {number} [resizeRegion.size=7]
18054
- * The size in pixels.
18055
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
18056
- * Sides that a window can be resized from.
18057
- *
18058
- * @property {boolean} [saveWindowState=true]
18059
- * A flag to cache the location of the window.
18060
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
18061
- *
18062
- * @property {boolean} [ignoreSavedWindowState]
18063
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
18064
- *
18065
- * @property {boolean} [shadow=false]
18066
- * A flag to display a shadow on frameless windows.
18067
- * `shadow` and `cornerRounding` are mutually exclusive.
18068
- * On Windows 7, Aero theme is required.
18069
- *
18070
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
18071
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
18072
- * This occurs when the window is resizing or a tab is being dragged within the layout.
18073
- *
18074
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
18075
- * A flag to show the window's icon in the taskbar.
18076
- *
18077
- * @property {boolean} [smallWindow=false]
18078
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
18079
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
18080
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
18081
- *
18082
- * @property {boolean} [spellCheck=false]
18083
- * Enable spell check in input text fields for the window.
18084
- *
18085
- * @property {string} [state="normal"]
18086
- * The visible state of the window on creation.
18087
- * One of:
18088
- * * `"maximized"`
18089
- * * `"minimized"`
18090
- * * `"normal"`
18091
- *
18092
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
18093
- *
18094
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
18095
- * Specify a taskbar group for the window.
18096
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
18097
- *
18098
- * @property {string} [url="about:blank"]
18099
- * The URL of the window.
18100
- *
18101
- * @property {string} [uuid=<application uuid>]
18102
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
18103
- * If omitted, defaults to the `uuid` of the application spawning the window.
18104
- * If given, must match the `uuid` of the application spawning the window.
18105
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
18106
- * really no need to provide it.
18107
- *
18108
- * @property {boolean} [waitForPageLoad=false]
18109
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
18110
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
18111
- *
18112
- * @property {ViewVisibility} [viewVisibility]
18113
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18114
- */
18115
- /**
18116
- * @PORTED
18117
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18118
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
18119
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18120
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
18121
- */
18122
- /**
18123
- * @PORTED
18124
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
18125
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
18126
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
18127
- */
18128
- /**
18129
- * @REMOVED
18130
- * @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.
18131
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
18132
- */
18133
- /**
18134
- * @REMOVED
18135
- * @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.
18136
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
18137
- */
18138
- /**
18139
- * @PORTED
18140
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
18141
- * @property { Area } [area] The area of the window to be captured.
18142
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
18143
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
18144
- */
18145
- /**
18146
- * @PORTED
18147
- * @typedef { object } Area@typedef { object } Area
18148
- * @property { number } height Area's height
18149
- * @property { number } width Area's width
18150
- * @property { number } x X coordinate of area's starting point
18151
- * @property { number } y Y coordinate of area's starting point
18152
- */
18153
- /**
18154
- * @PORTED
18155
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
18156
- * @property {boolean} [forward=true] Whether to search forward or backward.
18157
- * @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.
18158
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
18159
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
18160
- * @property {boolean} [medialCapitalAsWordStart=false]
18161
- * 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>
18162
- * lowercase or non-letter. Accepts several other intra-word matches.
18163
- */
18164
- /**
18165
- * @REMOVED
18166
- * @typedef {object} Transition@typedef {object} Transition
18167
- * @property {Opacity} opacity - The Opacity transition
18168
- * @property {Position} position - The Position transition
18169
- * @property {Size} size - The Size transition
18170
- */
18171
- /**
18172
- * @PORTED
18173
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
18174
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
18175
- this animation onto the end of the animation queue.
18176
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18177
- */
18178
- /**
18179
- * @PORTED
18180
- * @typedef {object} Size@typedef {object} Size
18181
- * @property {number} duration - The total time in milliseconds this transition should take.
18182
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18183
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
18184
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
18185
- */
18186
- /**
18187
- * @PORTED
18188
- * @typedef {object} Position@typedef {object} Position
18189
- * @property {number} duration - The total time in milliseconds this transition should take.
18190
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18191
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
18192
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
18193
- */
18194
- /**
18195
- * @PORTED
18196
- * @typedef {object} Opacity@typedef {object} Opacity
18197
- * @property {number} duration - The total time in milliseconds this transition should take.
18198
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18199
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
18200
- */
18201
- /**
18202
- * @REMOVED
18203
- * Bounds is a interface that has the properties of height,
18204
- * width, left, top which are all numbers
18205
- * @typedef { object } Bounds@typedef { object } Bounds
18206
- * @property { number } height Get the application height bound
18207
- * @property { number } width Get the application width bound
18208
- * @property { number } top Get the application top bound
18209
- * @property { number } left Get the application left bound
18210
- * @property { number } right Get the application right bound
18211
- * @property { number } bottom Get the application bottom bound
18212
- */
18213
17107
  /**
18214
17108
  * A basic window that wraps a native HTML window. Provides more fine-grained
18215
17109
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -19060,28 +17954,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19060
17954
  * ```
19061
17955
  */
19062
17956
  authenticate(userName: string, password: string): Promise<void>;
19063
- /**
19064
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
19065
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
19066
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
19067
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
19068
- */
19069
- /**
19070
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
19071
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
19072
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
19073
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
19074
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
19075
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
19076
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
19077
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
19078
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
19079
- */
19080
- /**
19081
- * @typedef {object} MenuResult@typedef {object} MenuResult
19082
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
19083
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
19084
- */
19085
17957
  /**
19086
17958
  * Shows a menu on the window.
19087
17959
  *
@@ -19178,577 +18050,552 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19178
18050
  */
19179
18051
  closePopupMenu(): Promise<void>;
19180
18052
  /**
19181
- * @PORTED
19182
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19183
- * @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.
19184
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19185
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19186
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19187
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19188
- * @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.
19189
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19190
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19191
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19192
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19193
- * @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.
19194
- * @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`.
19195
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19196
- * @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.
19197
- */
19198
- /**
19199
- * @PORTED
19200
- * @typedef {object} PopupResult@typedef {object} PopupResult
19201
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19202
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19203
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19204
- */
19205
- /**
19206
- * Dispatch a result to the caller of `showPopupWindow`.
19207
- *
19208
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19209
- * @param data Serializable data to send to the caller window.
19210
- *
19211
- * @example
19212
- * ```js
19213
- * await fin.me.dispatchPopupResult({
19214
- * foo: 'bar'
19215
- * });
19216
- * ```
19217
- */
19218
- dispatchPopupResult(data: any): Promise<void>;
19219
- /**
19220
- * Prints the contents of the window.
19221
- *
19222
- * @param options Configuration for the print task.
19223
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19224
- * and the default settings for printing.
19225
- *
19226
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19227
- *
19228
- * @example
19229
- * ```js
19230
- * const win = fin.Window.getCurrentSync();
19231
- *
19232
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19233
- * console.log('print call has been sent to the system');
19234
- * });
19235
- * ```
19236
- *
19237
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19238
- * use the `content` option:
19239
- *
19240
- * ```js
19241
- * const win = fin.Window.getCurrentSync();
19242
- *
19243
- * // Print embedded views
19244
- * win.print({ content: 'views' });
19245
- *
19246
- * // Print screenshot of current window
19247
- * win.print({ content: 'screenshot' })
19248
- * ```
19249
- *
19250
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19251
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19252
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19253
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19254
- *
19255
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19256
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19257
- *
19258
- * To print the views embedded in their page context, set `content` to `screenshot`.
19259
- */
19260
- print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
19261
- }
19262
-
19263
- /**
19264
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19265
- * @interface
19266
- */
19267
- declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19268
- type: 'window-alert-requested';
19269
- };
19270
-
19271
- /**
19272
- * Returned from getBounds call. bottom and right are never used for setting.
19273
- * @interface
19274
- */
19275
- declare type WindowBounds = Bounds & {
19276
- bottom: number;
19277
- right: number;
19278
- };
19279
-
19280
- /**
19281
- * @deprecated Renamed to {@link ClosedEvent}.
19282
- */
19283
- declare type WindowClosedEvent = ClosedEvent_2;
19284
-
19285
- /**
19286
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19287
- */
19288
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19289
-
19290
- /**
19291
- * @deprecated Renamed to {@link ClosingEvent}.
19292
- */
19293
- declare type WindowClosingEvent = ClosingEvent;
19294
-
19295
- /**
19296
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19297
- *
19298
- * @interface
19299
- */
19300
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19301
- /**
19302
- * Behavior to use when opening matched content.
19303
- */
19304
- behavior: 'window';
19305
- /**
19306
- * Options for newly-created window.
19307
- */
19308
- options?: Partial<WindowOptions>;
19309
- };
19310
-
19311
- /**
19312
- * Generated when a child window is created.
19313
- * @interface
19314
- */
19315
- declare type WindowCreatedEvent = BaseEvent_3 & {
19316
- type: 'window-created';
19317
- };
19318
-
19319
- /**
19320
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19321
- *
19322
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19323
- * (defaults to `"about:blank"` when omitted).
19324
- * @interface
19325
- */
19326
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19327
- name: string;
19328
- };
19329
-
19330
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19331
-
19332
- /**
19333
- * @interface
19334
- */
19335
- declare type WindowDetail = {
19336
- /**
19337
- * The bottom-most coordinate of the window.
19338
- */
19339
- bottom: number;
19340
- /**
19341
- * The height of the window.
19342
- */
19343
- height: number;
19344
- isShowing: boolean;
19345
- /**
19346
- * The left-most coordinate of the window.
19347
- */
19348
- left: number;
19349
- /**
19350
- * The name of the window.
19351
- */
19352
- name: string;
19353
- /**
19354
- * The right-most coordinate of the window.
19355
- */
19356
- right: number;
19357
- state: string;
19358
- /**
19359
- * The top-most coordinate of the window.
19360
- */
19361
- top: number;
19362
- /**
19363
- * The width of the window.
19364
- */
19365
- width: number;
19366
- };
19367
-
19368
- /**
19369
- * Generated when a child window ends loading.
19370
- * @interface
19371
- */
19372
- declare type WindowEndLoadEvent = BaseEvent_3 & {
19373
- type: 'window-end-load';
19374
- };
19375
-
19376
- /**
19377
- * @deprecated, Renamed to {@link Event}.
19378
- */
19379
- declare type WindowEvent = Event_6;
19380
-
19381
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19382
-
19383
- declare namespace WindowEvents {
19384
- export {
19385
- BaseEvent_5 as BaseEvent,
19386
- BaseWindowEvent,
19387
- ViewAttachedEvent,
19388
- ViewDetachedEvent,
19389
- WindowViewEvent,
19390
- AlertRequestedEvent,
19391
- AuthRequestedEvent,
19392
- EndLoadEvent,
19393
- WillRedirectEvent,
19394
- ReloadedEvent,
19395
- OptionsChangedEvent,
19396
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19397
- ExternalProcessExitedEvent,
19398
- ExternalProcessStartedEvent,
19399
- HiddenEvent_2 as HiddenEvent,
19400
- WindowHiddenEvent,
19401
- PreloadScriptInfoRunning,
19402
- PreloadScriptInfo,
19403
- PreloadScriptsStateChangeEvent,
19404
- UserBoundsChangeEvent,
19405
- BoundsChangeEvent,
19406
- WillMoveOrResizeEvent,
19407
- PerformanceReportEvent,
19408
- InputEvent_2 as InputEvent,
19409
- LayoutInitializedEvent,
19410
- LayoutReadyEvent,
19411
- BeginUserBoundsChangingEvent,
19412
- BoundsChangedEvent,
19413
- BoundsChangingEvent,
19414
- CloseRequestedEvent,
19415
- WindowCloseRequestedEvent,
19416
- ContextChangedEvent,
19417
- ClosedEvent_2 as ClosedEvent,
19418
- WindowClosedEvent,
19419
- ClosingEvent,
19420
- WindowClosingEvent,
19421
- DisabledMovementBoundsChangedEvent,
19422
- DisabledMovementBoundsChangingEvent,
19423
- EmbeddedEvent,
19424
- EndUserBoundsChangingEvent,
19425
- HotkeyEvent_2 as HotkeyEvent,
19426
- WindowHotkeyEvent,
19427
- InitializedEvent_2 as InitializedEvent,
19428
- WindowInitializedEvent,
19429
- MaximizedEvent,
19430
- MinimizedEvent,
19431
- PreloadScriptsStateChangedEvent,
19432
- PreloadScriptsStateChangingEvent,
19433
- RestoredEvent,
19434
- WindowRestoredEvent,
19435
- ShowRequestedEvent,
19436
- WindowShowRequestedEvent,
19437
- ShownEvent_2 as ShownEvent,
19438
- WindowShownEvent,
19439
- UserMovementEnabledEvent,
19440
- UserMovementDisabledEvent,
19441
- WillMoveEvent,
19442
- WillResizeEvent,
19443
- NonPropagatedWindowEvent,
19444
- ShowAllDownloadsEvent,
19445
- DownloadShelfVisibilityChangedEvent,
19446
- WindowSourcedEvent,
19447
- WillPropagateWindowEvent,
19448
- Event_6 as Event,
19449
- WindowEvent,
19450
- EventType_2 as EventType,
19451
- WindowEventType,
19452
- PropagatedEvent_3 as PropagatedEvent,
19453
- PropagatedWindowEvent,
19454
- PropagatedWindowEventType,
19455
- Payload_3 as Payload,
19456
- ByType_2 as ByType
19457
- }
19458
- }
19459
-
19460
- /**
19461
- * @deprecated Renamed to {@link EventType}.
19462
- */
19463
- declare type WindowEventType = WindowEvent['type'];
19464
-
19465
- /**
19466
- * @deprecated Renamed to {@link HiddenEvent}.
19467
- */
19468
- declare type WindowHiddenEvent = HiddenEvent_2;
19469
-
19470
- /**
19471
- * @deprecated Renamed to {@link HotkeyEvent}.
19472
- */
19473
- declare type WindowHotkeyEvent = HotkeyEvent_2;
19474
-
19475
- /**
19476
- * @interface
19477
- */
19478
- declare type WindowInfo = {
19479
- canNavigateBack: boolean;
19480
- canNavigateForward: boolean;
19481
- preloadScripts: Array<any>;
19482
- title: string;
19483
- url: string;
19484
- };
19485
-
19486
- /**
19487
- * @deprecated Renamed to {@link InitializedEvent}.
19488
- */
19489
- declare type WindowInitializedEvent = InitializedEvent_2;
19490
-
19491
- /**
19492
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
19493
- */
19494
- declare class _WindowModule extends Base {
19495
- /**
19496
- * Asynchronously returns a Window object that represents an existing window.
19497
- *
19498
- * @example
19499
- * ```js
19500
- * async function createWin() {
19501
- * const app = await fin.Application.start({
19502
- * name: 'myApp',
19503
- * uuid: 'app-1',
19504
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
19505
- * autoShow: true
19506
- * });
19507
- * return await app.getWindow();
19508
- * }
19509
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
19510
- * .then(win => console.log('wrapped window'))
19511
- * .catch(err => console.log(err));
19512
- * ```
19513
- */
19514
- wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
19515
- /**
19516
- * Synchronously returns a Window object that represents an existing window.
19517
- *
19518
- * @example
19519
- * ```js
19520
- * async function createWin() {
19521
- * const app = await fin.Application.start({
19522
- * name: 'myApp',
19523
- * uuid: 'app-1',
19524
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
19525
- * autoShow: true
19526
- * });
19527
- * return await app.getWindow();
19528
- * }
19529
- * await createWin();
19530
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
19531
- * ```
19532
- */
19533
- wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
19534
- /**
19535
- * Creates a new Window.
19536
- * @param options - Window creation options
19537
- *
19538
- * @example
19539
- * ```js
19540
- * async function createWindow() {
19541
- * const winOption = {
19542
- * name:'child',
19543
- * defaultWidth: 300,
19544
- * defaultHeight: 300,
19545
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
19546
- * frame: true,
19547
- * autoShow: true
19548
- * };
19549
- * return await fin.Window.create(winOption);
19550
- * }
19551
- *
19552
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
19553
- * ```
19554
- */
19555
- create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
19556
- /**
19557
- * Asynchronously returns a Window object that represents the current window
19558
- *
19559
- * @example
19560
- * ```js
19561
- * fin.Window.getCurrent()
19562
- * .then(wnd => console.log('current window'))
19563
- * .catch(err => console.log(err));
19564
- *
19565
- * ```
19566
- */
19567
- getCurrent(): Promise<OpenFin_2.Window>;
19568
- /**
19569
- * Synchronously returns a Window object that represents the current window
19570
- *
19571
- * @example
19572
- * ```js
19573
- * const wnd = fin.Window.getCurrentSync();
19574
- * const info = await wnd.getInfo();
19575
- * console.log(info);
19576
- *
19577
- * ```
19578
- */
19579
- getCurrentSync(): OpenFin_2.Window;
19580
- }
19581
-
19582
- /**
19583
- * Generated when a child window is not responding.
19584
- * @interface
19585
- */
19586
- declare type WindowNotRespondingEvent = BaseEvent_3 & {
19587
- type: 'window-not-responding';
19588
- };
19589
-
19590
- /**
19591
- * @interface
19592
- */
19593
- declare type WindowOptionDiff = {
19594
- [key in keyof WindowOptions]: {
19595
- oldVal: WindowOptions[key];
19596
- newVal: WindowOptions[key];
19597
- };
19598
- };
19599
-
19600
- /**
19601
- * @interface
19602
- */
19603
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
19604
-
19605
- declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
19606
-
19607
- /**
19608
- * @deprecated Renamed to {@link OptionsChangedEvent}.
19609
- */
19610
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19611
-
19612
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19613
-
19614
- /**
19615
- * Generated when a child window is responding.
19616
- * @interface
19617
- */
19618
- declare type WindowRespondingEvent = BaseEvent_3 & {
19619
- type: 'window-responding';
19620
- };
19621
-
19622
- /**
19623
- * @deprecated Renamed to {@link RestoredEvent}.
19624
- */
19625
- declare type WindowRestoredEvent = RestoredEvent;
19626
-
19627
- /**
19628
- * @deprecated Renamed to {@link ShownEvent}.
19629
- */
19630
- declare type WindowShownEvent = ShownEvent_2;
19631
-
19632
- /**
19633
- * @deprecated Renamed to {@link ShowRequestedEvent}.
19634
- */
19635
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
19636
-
19637
- /**
19638
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19639
- * from {@link OpenFin.ViewEvents}.
19640
- */
19641
- 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;
19642
-
19643
- /**
19644
- * Generated when a child window starts loading.
19645
- * @interface
19646
- */
19647
- declare type WindowStartLoadEvent = BaseEvent_3 & {
19648
- type: 'window-start-load';
19649
- };
19650
-
19651
- /**
19652
- * Visibility state of a window.
19653
- */
19654
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
19655
-
19656
- /**
19657
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19658
- * to the `Application` level, with the name pattern `window-view-eventname`.
19659
- */
19660
- declare type WindowViewEvent = {
19661
- viewIdentity: OpenFin_2.Identity;
19662
- } & (ViewAttachedEvent | ViewDetachedEvent);
19663
-
19664
- /**
19665
- * @interface
19666
- */
19667
- declare type WindowViewsPrintOptions = {
19668
- content: 'views';
19669
- includeSelf?: boolean;
19670
- };
19671
-
19672
- declare type Wire = EventEmitter & {
19673
- connect(messageReciever: MessageReceiver): Promise<any>;
19674
- connectSync(): any;
19675
- send(data: any): Promise<any>;
19676
- shutdown(): Promise<void>;
19677
- getPort(): string;
19678
- };
19679
-
19680
- declare type WireConstructor = {
19681
- new (onmessage: (data: any) => void): Wire;
19682
- };
19683
-
19684
- /* Excluded from this release type: WithId */
19685
-
19686
- declare interface WithInterop {
19687
- interop: InteropClient;
19688
- }
19689
-
19690
- /* Excluded from this release type: WithoutId */
19691
-
19692
- declare type WithPositioningOptions<T extends {} = {}> = T & {
19693
- positioningOptions?: OpenFin_2.PositioningOptions;
19694
- };
19695
-
19696
- /* Excluded from this release type: WorkspacePlatformOptions */
19697
-
19698
- /**
19699
- * A generic request to write any supported data to the clipboard.
19700
- * @interface
19701
- */
19702
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19703
- /**
19704
- * Data to be written
19705
- */
19706
- data: {
19707
- text?: string;
19708
- html?: string;
19709
- rtf?: string;
19710
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19711
- };
19712
-
19713
- /**
19714
- * @deprecated - instead use WriteAnyClipboardRequest
19715
- *
19716
- * A generic request to write any supported data to the clipboard.
19717
- *
19718
- * @interface
19719
- */
19720
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19721
-
19722
- /**
19723
- * A request to write data to the clipboard.
19724
- * @interface
19725
- */
19726
- declare type WriteClipboardRequest = BaseClipboardRequest & {
19727
- /**
19728
- * Data to write to the clipboard.
19729
- */
19730
- data: string;
19731
- };
19732
-
19733
- /**
19734
- * @interface
19735
- */
19736
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19737
- /**
19738
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
19739
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19740
- * Using other image/<format> DataURLs will throw an Error.
19741
- */
19742
- image: string;
19743
- };
19744
-
19745
- /**
19746
- * @deprecated - instead use OpenFin.WriteClipboardRequest
19747
- *
19748
- * A request to write data to the clipboard.
19749
- *
19750
- * @interface
19751
- */
19752
- declare type WriteRequestType = WriteClipboardRequest;
19753
-
19754
- export { }
18053
+ * Dispatch a result to the caller of `showPopupWindow`.
18054
+ *
18055
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18056
+ * @param data Serializable data to send to the caller window.
18057
+ *
18058
+ * @example
18059
+ * ```js
18060
+ * await fin.me.dispatchPopupResult({
18061
+ * foo: 'bar'
18062
+ * });
18063
+ * ```
18064
+ */
18065
+ dispatchPopupResult(data: any): Promise<void>;
18066
+ /**
18067
+ * Prints the contents of the window.
18068
+ *
18069
+ * @param options Configuration for the print task.
18070
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18071
+ * and the default settings for printing.
18072
+ *
18073
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18074
+ *
18075
+ * @example
18076
+ * ```js
18077
+ * const win = fin.Window.getCurrentSync();
18078
+ *
18079
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18080
+ * console.log('print call has been sent to the system');
18081
+ * });
18082
+ * ```
18083
+ *
18084
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18085
+ * use the `content` option:
18086
+ *
18087
+ * ```js
18088
+ * const win = fin.Window.getCurrentSync();
18089
+ *
18090
+ * // Print embedded views
18091
+ * win.print({ content: 'views' });
18092
+ *
18093
+ * // Print screenshot of current window
18094
+ * win.print({ content: 'screenshot' })
18095
+ * ```
18096
+ *
18097
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18098
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18099
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18100
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18101
+ *
18102
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18103
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18104
+ *
18105
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18106
+ */
18107
+ print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
18108
+ }
18109
+
18110
+ /**
18111
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18112
+ * @interface
18113
+ */
18114
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18115
+ type: 'window-alert-requested';
18116
+ };
18117
+
18118
+ /**
18119
+ * Returned from getBounds call. bottom and right are never used for setting.
18120
+ * @interface
18121
+ */
18122
+ declare type WindowBounds = Bounds & {
18123
+ bottom: number;
18124
+ right: number;
18125
+ };
18126
+
18127
+ /**
18128
+ * @deprecated Renamed to {@link ClosedEvent}.
18129
+ */
18130
+ declare type WindowClosedEvent = ClosedEvent_2;
18131
+
18132
+ /**
18133
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18134
+ */
18135
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18136
+
18137
+ /**
18138
+ * @deprecated Renamed to {@link ClosingEvent}.
18139
+ */
18140
+ declare type WindowClosingEvent = ClosingEvent;
18141
+
18142
+ /**
18143
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18144
+ *
18145
+ * @interface
18146
+ */
18147
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18148
+ /**
18149
+ * Behavior to use when opening matched content.
18150
+ */
18151
+ behavior: 'window';
18152
+ /**
18153
+ * Options for newly-created window.
18154
+ */
18155
+ options?: Partial<WindowOptions>;
18156
+ };
18157
+
18158
+ /**
18159
+ * Generated when a child window is created.
18160
+ * @interface
18161
+ */
18162
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18163
+ type: 'window-created';
18164
+ };
18165
+
18166
+ /**
18167
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18168
+ *
18169
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18170
+ * (defaults to `"about:blank"` when omitted).
18171
+ * @interface
18172
+ */
18173
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18174
+ name: string;
18175
+ };
18176
+
18177
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18178
+
18179
+ /**
18180
+ * @interface
18181
+ */
18182
+ declare type WindowDetail = {
18183
+ /**
18184
+ * The bottom-most coordinate of the window.
18185
+ */
18186
+ bottom: number;
18187
+ /**
18188
+ * The height of the window.
18189
+ */
18190
+ height: number;
18191
+ isShowing: boolean;
18192
+ /**
18193
+ * The left-most coordinate of the window.
18194
+ */
18195
+ left: number;
18196
+ /**
18197
+ * The name of the window.
18198
+ */
18199
+ name: string;
18200
+ /**
18201
+ * The right-most coordinate of the window.
18202
+ */
18203
+ right: number;
18204
+ state: string;
18205
+ /**
18206
+ * The top-most coordinate of the window.
18207
+ */
18208
+ top: number;
18209
+ /**
18210
+ * The width of the window.
18211
+ */
18212
+ width: number;
18213
+ };
18214
+
18215
+ /**
18216
+ * Generated when a child window ends loading.
18217
+ * @interface
18218
+ */
18219
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18220
+ type: 'window-end-load';
18221
+ };
18222
+
18223
+ /**
18224
+ * @deprecated, Renamed to {@link Event}.
18225
+ */
18226
+ declare type WindowEvent = Event_6;
18227
+
18228
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18229
+
18230
+ declare namespace WindowEvents {
18231
+ export {
18232
+ BaseEvent_5 as BaseEvent,
18233
+ BaseWindowEvent,
18234
+ ViewAttachedEvent,
18235
+ ViewDetachedEvent,
18236
+ WindowViewEvent,
18237
+ AlertRequestedEvent,
18238
+ AuthRequestedEvent,
18239
+ EndLoadEvent,
18240
+ WillRedirectEvent,
18241
+ ReloadedEvent,
18242
+ OptionsChangedEvent,
18243
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18244
+ ExternalProcessExitedEvent,
18245
+ ExternalProcessStartedEvent,
18246
+ HiddenEvent_2 as HiddenEvent,
18247
+ WindowHiddenEvent,
18248
+ PreloadScriptInfoRunning,
18249
+ PreloadScriptInfo,
18250
+ PreloadScriptsStateChangeEvent,
18251
+ UserBoundsChangeEvent,
18252
+ BoundsChangeEvent,
18253
+ WillMoveOrResizeEvent,
18254
+ PerformanceReportEvent,
18255
+ InputEvent_2 as InputEvent,
18256
+ LayoutInitializedEvent,
18257
+ LayoutReadyEvent,
18258
+ BeginUserBoundsChangingEvent,
18259
+ BoundsChangedEvent,
18260
+ BoundsChangingEvent,
18261
+ CloseRequestedEvent,
18262
+ WindowCloseRequestedEvent,
18263
+ ContextChangedEvent,
18264
+ ClosedEvent_2 as ClosedEvent,
18265
+ WindowClosedEvent,
18266
+ ClosingEvent,
18267
+ WindowClosingEvent,
18268
+ DisabledMovementBoundsChangedEvent,
18269
+ DisabledMovementBoundsChangingEvent,
18270
+ EmbeddedEvent,
18271
+ EndUserBoundsChangingEvent,
18272
+ HotkeyEvent_2 as HotkeyEvent,
18273
+ WindowHotkeyEvent,
18274
+ InitializedEvent_2 as InitializedEvent,
18275
+ WindowInitializedEvent,
18276
+ MaximizedEvent,
18277
+ MinimizedEvent,
18278
+ PreloadScriptsStateChangedEvent,
18279
+ PreloadScriptsStateChangingEvent,
18280
+ RestoredEvent,
18281
+ WindowRestoredEvent,
18282
+ ShowRequestedEvent,
18283
+ WindowShowRequestedEvent,
18284
+ ShownEvent_2 as ShownEvent,
18285
+ WindowShownEvent,
18286
+ UserMovementEnabledEvent,
18287
+ UserMovementDisabledEvent,
18288
+ WillMoveEvent,
18289
+ WillResizeEvent,
18290
+ NonPropagatedWindowEvent,
18291
+ ShowAllDownloadsEvent,
18292
+ DownloadShelfVisibilityChangedEvent,
18293
+ WindowSourcedEvent,
18294
+ WillPropagateWindowEvent,
18295
+ Event_6 as Event,
18296
+ WindowEvent,
18297
+ EventType_2 as EventType,
18298
+ WindowEventType,
18299
+ PropagatedEvent_3 as PropagatedEvent,
18300
+ PropagatedWindowEvent,
18301
+ PropagatedWindowEventType,
18302
+ Payload_3 as Payload,
18303
+ ByType_2 as ByType
18304
+ }
18305
+ }
18306
+
18307
+ /**
18308
+ * @deprecated Renamed to {@link EventType}.
18309
+ */
18310
+ declare type WindowEventType = WindowEvent['type'];
18311
+
18312
+ /**
18313
+ * @deprecated Renamed to {@link HiddenEvent}.
18314
+ */
18315
+ declare type WindowHiddenEvent = HiddenEvent_2;
18316
+
18317
+ /**
18318
+ * @deprecated Renamed to {@link HotkeyEvent}.
18319
+ */
18320
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18321
+
18322
+ /**
18323
+ * @interface
18324
+ */
18325
+ declare type WindowInfo = {
18326
+ canNavigateBack: boolean;
18327
+ canNavigateForward: boolean;
18328
+ preloadScripts: Array<any>;
18329
+ title: string;
18330
+ url: string;
18331
+ };
18332
+
18333
+ /**
18334
+ * @deprecated Renamed to {@link InitializedEvent}.
18335
+ */
18336
+ declare type WindowInitializedEvent = InitializedEvent_2;
18337
+
18338
+ /**
18339
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18340
+ */
18341
+ declare class _WindowModule extends Base {
18342
+ /**
18343
+ * Asynchronously returns a Window object that represents an existing window.
18344
+ *
18345
+ * @example
18346
+ * ```js
18347
+ * async function createWin() {
18348
+ * const app = await fin.Application.start({
18349
+ * name: 'myApp',
18350
+ * uuid: 'app-1',
18351
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18352
+ * autoShow: true
18353
+ * });
18354
+ * return await app.getWindow();
18355
+ * }
18356
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18357
+ * .then(win => console.log('wrapped window'))
18358
+ * .catch(err => console.log(err));
18359
+ * ```
18360
+ */
18361
+ wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
18362
+ /**
18363
+ * Synchronously returns a Window object that represents an existing window.
18364
+ *
18365
+ * @example
18366
+ * ```js
18367
+ * async function createWin() {
18368
+ * const app = await fin.Application.start({
18369
+ * name: 'myApp',
18370
+ * uuid: 'app-1',
18371
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18372
+ * autoShow: true
18373
+ * });
18374
+ * return await app.getWindow();
18375
+ * }
18376
+ * await createWin();
18377
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18378
+ * ```
18379
+ */
18380
+ wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
18381
+ /**
18382
+ * Creates a new Window.
18383
+ * @param options - Window creation options
18384
+ *
18385
+ * @example
18386
+ * ```js
18387
+ * async function createWindow() {
18388
+ * const winOption = {
18389
+ * name:'child',
18390
+ * defaultWidth: 300,
18391
+ * defaultHeight: 300,
18392
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18393
+ * frame: true,
18394
+ * autoShow: true
18395
+ * };
18396
+ * return await fin.Window.create(winOption);
18397
+ * }
18398
+ *
18399
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18400
+ * ```
18401
+ */
18402
+ create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
18403
+ /**
18404
+ * Asynchronously returns a Window object that represents the current window
18405
+ *
18406
+ * @example
18407
+ * ```js
18408
+ * fin.Window.getCurrent()
18409
+ * .then(wnd => console.log('current window'))
18410
+ * .catch(err => console.log(err));
18411
+ *
18412
+ * ```
18413
+ */
18414
+ getCurrent(): Promise<OpenFin_2.Window>;
18415
+ /**
18416
+ * Synchronously returns a Window object that represents the current window
18417
+ *
18418
+ * @example
18419
+ * ```js
18420
+ * const wnd = fin.Window.getCurrentSync();
18421
+ * const info = await wnd.getInfo();
18422
+ * console.log(info);
18423
+ *
18424
+ * ```
18425
+ */
18426
+ getCurrentSync(): OpenFin_2.Window;
18427
+ }
18428
+
18429
+ /**
18430
+ * Generated when a child window is not responding.
18431
+ * @interface
18432
+ */
18433
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18434
+ type: 'window-not-responding';
18435
+ };
18436
+
18437
+ /**
18438
+ * @interface
18439
+ */
18440
+ declare type WindowOptionDiff = {
18441
+ [key in keyof WindowOptions]: {
18442
+ oldVal: WindowOptions[key];
18443
+ newVal: WindowOptions[key];
18444
+ };
18445
+ };
18446
+
18447
+ /**
18448
+ * @interface
18449
+ */
18450
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18451
+
18452
+ declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
18453
+
18454
+ /**
18455
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18456
+ */
18457
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18458
+
18459
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18460
+
18461
+ /**
18462
+ * Generated when a child window is responding.
18463
+ * @interface
18464
+ */
18465
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18466
+ type: 'window-responding';
18467
+ };
18468
+
18469
+ /**
18470
+ * @deprecated Renamed to {@link RestoredEvent}.
18471
+ */
18472
+ declare type WindowRestoredEvent = RestoredEvent;
18473
+
18474
+ /**
18475
+ * @deprecated Renamed to {@link ShownEvent}.
18476
+ */
18477
+ declare type WindowShownEvent = ShownEvent_2;
18478
+
18479
+ /**
18480
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18481
+ */
18482
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18483
+
18484
+ /**
18485
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18486
+ * from {@link OpenFin.ViewEvents}.
18487
+ */
18488
+ 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;
18489
+
18490
+ /**
18491
+ * Generated when a child window starts loading.
18492
+ * @interface
18493
+ */
18494
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18495
+ type: 'window-start-load';
18496
+ };
18497
+
18498
+ /**
18499
+ * Visibility state of a window.
18500
+ */
18501
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18502
+
18503
+ /**
18504
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18505
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18506
+ */
18507
+ declare type WindowViewEvent = {
18508
+ viewIdentity: OpenFin_2.Identity;
18509
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18510
+
18511
+ /**
18512
+ * @interface
18513
+ */
18514
+ declare type WindowViewsPrintOptions = {
18515
+ content: 'views';
18516
+ includeSelf?: boolean;
18517
+ };
18518
+
18519
+ declare type Wire = EventEmitter & {
18520
+ connect(messageReciever: MessageReceiver): Promise<any>;
18521
+ connectSync(): any;
18522
+ send(data: any): Promise<any>;
18523
+ shutdown(): Promise<void>;
18524
+ getPort(): string;
18525
+ };
18526
+
18527
+ declare type WireConstructor = {
18528
+ new (onmessage: (data: any) => void): Wire;
18529
+ };
18530
+
18531
+ /* Excluded from this release type: WithId */
18532
+
18533
+ declare interface WithInterop {
18534
+ interop: InteropClient;
18535
+ }
18536
+
18537
+ /* Excluded from this release type: WithoutId */
18538
+
18539
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18540
+ positioningOptions?: OpenFin_2.PositioningOptions;
18541
+ };
18542
+
18543
+ /* Excluded from this release type: WorkspacePlatformOptions */
18544
+
18545
+ /**
18546
+ * A generic request to write any supported data to the clipboard.
18547
+ * @interface
18548
+ */
18549
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18550
+ /**
18551
+ * Data to be written
18552
+ */
18553
+ data: {
18554
+ text?: string;
18555
+ html?: string;
18556
+ rtf?: string;
18557
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18558
+ };
18559
+
18560
+ /**
18561
+ * @deprecated - instead use WriteAnyClipboardRequest
18562
+ *
18563
+ * A generic request to write any supported data to the clipboard.
18564
+ *
18565
+ * @interface
18566
+ */
18567
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
18568
+
18569
+ /**
18570
+ * A request to write data to the clipboard.
18571
+ * @interface
18572
+ */
18573
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
18574
+ /**
18575
+ * Data to write to the clipboard.
18576
+ */
18577
+ data: string;
18578
+ };
18579
+
18580
+ /**
18581
+ * @interface
18582
+ */
18583
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
18584
+ /**
18585
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
18586
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
18587
+ * Using other image/<format> DataURLs will throw an Error.
18588
+ */
18589
+ image: string;
18590
+ };
18591
+
18592
+ /**
18593
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
18594
+ *
18595
+ * A request to write data to the clipboard.
18596
+ *
18597
+ * @interface
18598
+ */
18599
+ declare type WriteRequestType = WriteClipboardRequest;
18600
+
18601
+ export { }