@openfin/core 35.78.6 → 35.78.8

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.
@@ -43,6 +43,8 @@ declare type Accelerator = {
43
43
  };
44
44
 
45
45
  /**
46
+ * Options to use when adding a view to a {@link TabStack}.
47
+ *
46
48
  * @interface
47
49
  */
48
50
  declare type AddViewOptions = CreateViewTarget & {
@@ -94,6 +96,10 @@ declare type Api = {
94
96
  sameOriginInjection?: boolean;
95
97
  enableDeprecatedSharedName?: boolean;
96
98
  };
99
+ /**
100
+ * Prevent fin API injection. If 'none', `fin` won't be available in this context.
101
+ */
102
+ fin?: InjectionType;
97
103
  };
98
104
 
99
105
  declare type ApiCall<Request, Response> = {
@@ -187,100 +193,6 @@ declare class Application extends EmitterBase<OpenFin_2.ApplicationEvent> {
187
193
  private window;
188
194
  /* Excluded from this release type: __constructor */
189
195
  private windowListFromIdentityList;
190
- /**
191
- * Adds a listener to the end of the listeners array for the specified event.
192
- * @param eventType - The type of the event.
193
- * @param listener - Called whenever an event of the specified type occurs.
194
- * @param options - Option to support event timestamps.
195
- *
196
- * @function addListener
197
- * @memberof Application
198
- * @instance
199
- * @tutorial Application.EventEmitter
200
- */
201
- /**
202
- * Adds a listener to the end of the listeners array for the specified event.
203
- * @param eventType - The type of the event.
204
- * @param listener - Called whenever an event of the specified type occurs.
205
- * @param options - Option to support event timestamps.
206
- *
207
- * @function on
208
- * @memberof Application
209
- * @instance
210
- * @tutorial Application.EventEmitter
211
- */
212
- /**
213
- * 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.
214
- * @param eventType - The type of the event.
215
- * @param listener - The callback function.
216
- * @param options - Option to support event timestamps.
217
- *
218
- * @function once
219
- * @memberof Application
220
- * @instance
221
- * @tutorial Application.EventEmitter
222
- */
223
- /**
224
- * Adds a listener to the beginning of the listeners array for the specified event.
225
- * @param eventType - The type of the event.
226
- * @param listener - The callback function.
227
- * @param options - Option to support event timestamps.
228
- *
229
- * @function prependListener
230
- * @memberof Application
231
- * @instance
232
- * @tutorial Application.EventEmitter
233
- */
234
- /**
235
- * 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.
236
- * The listener is added to the beginning of the listeners array.
237
- * @param eventType - The type of the event.
238
- * @param listener - The callback function.
239
- * @param options - Option to support event timestamps.
240
- *
241
- * @function prependOnceListener
242
- * @memberof Application
243
- * @instance
244
- * @tutorial Application.EventEmitter
245
- */
246
- /**
247
- * Remove a listener from the listener array for the specified event.
248
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
249
- * @param eventType - The type of the event.
250
- * @param listener - The callback function.
251
- * @param options - Option to support event timestamps.
252
- *
253
- * @function removeListener
254
- * @memberof Application
255
- * @instance
256
- * @tutorial Application.EventEmitter
257
- */
258
- /**
259
- * Removes all listeners, or those of the specified event.
260
- * @param eventType - The type of the event.
261
- *
262
- * @function removeAllListeners
263
- * @memberof Application
264
- * @instance
265
- * @tutorial Application.EventEmitter
266
- */
267
- /**
268
- * JumpListCategory interface
269
- * @typedef { object } JumpListCategory@typedef { object } JumpListCategory
270
- * @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.
271
- * @property { JumpListItem[] } items Array of JumpListItem objects
272
- */
273
- /**
274
- * @PORTED
275
- * JumpListItem interface
276
- * @typedef { object } JumpListItem@typedef { object } JumpListItem
277
- * @property { string } type One of the following: "task" or "separator". Defaults to task.
278
- * @property { string } title The text to be displayed for the JumpList Item. Should only be set if type is "task".
279
- * @property { string } description Description of the task (displayed in a tooltip). Should only be set if type is "task".
280
- * @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.
281
- * @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).
282
- * @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.
283
- */
284
196
  /**
285
197
  * Determines if the application is currently running.
286
198
  *
@@ -927,6 +839,7 @@ declare namespace ApplicationEvents {
927
839
  RespondingEvent,
928
840
  StartedEvent,
929
841
  ApplicationSourcedEvent,
842
+ ApplicationSourcedEventType,
930
843
  Event_3 as Event,
931
844
  ApplicationEvent,
932
845
  EventType_3 as EventType,
@@ -1299,6 +1212,11 @@ declare type ApplicationPermissions = {
1299
1212
  */
1300
1213
  declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
1301
1214
 
1215
+ /**
1216
+ * Union of possible type values for an {@link ApplicationSourcedEvent}.
1217
+ */
1218
+ declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
1219
+
1302
1220
  declare type ApplicationState = OpenFin_2.ApplicationState;
1303
1221
 
1304
1222
  /**
@@ -3102,20 +3020,6 @@ declare type ClientInfo = Omit<ClientIdentity, 'isLocalEndpointId'> & {
3102
3020
  connectionUrl: string;
3103
3021
  };
3104
3022
 
3105
- /**
3106
- * @PORTED
3107
- * WriteRequestType interface
3108
- * @typedef { object } WriteRequestType@typedef { object } WriteRequestType
3109
- * @property { string } data Data to be written
3110
- * @property { string } [type] Clipboard Type
3111
- */
3112
- /**
3113
- * @PORTED
3114
- * OpenFin.WriteAnyClipboardRequest interface
3115
- * @typedef { object } OpenFin.WriteAnyClipboardRequest@typedef { object } OpenFin.WriteAnyClipboardRequest
3116
- * @property { string } data Data to be written
3117
- * @property { OpenFin.ClipboardSelectionType } [type] Clipboard Type defaults to 'clipboard', use 'selection' for linux
3118
- */
3119
3023
  /**
3120
3024
  * The Clipboard API allows reading and writing to the clipboard in multiple formats.
3121
3025
  *
@@ -3488,6 +3392,10 @@ declare type ConstructorOverride<T> = (Base: Constructor<T>) => Constructor<T>;
3488
3392
  * @interface
3489
3393
  */
3490
3394
  declare type ConstViewOptions = {
3395
+ /**
3396
+ * Configurations for API injection.
3397
+ */
3398
+ api: Api;
3491
3399
  /**
3492
3400
  * The name of the view.
3493
3401
  */
@@ -3636,7 +3544,7 @@ declare type ConstWindowOptions = {
3636
3544
  /**
3637
3545
  * @defaultValue true
3638
3546
  *
3639
- * Toggling off would keep the Window alive even if all its Views were closed.
3547
+ * Setting this to false would keep the Window alive even if all its Views were closed.
3640
3548
  * This is meant for advanced users and should be used with caution.
3641
3549
  * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
3642
3550
  * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
@@ -3646,7 +3554,8 @@ declare type ConstWindowOptions = {
3646
3554
  /**
3647
3555
  * @defaultValue 'all'
3648
3556
  *
3649
- * Determines which views prevent close if `closeOnLastViewRemoved` is set to true. Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3557
+ * When `closeOnLastViewRemoved` is set to true, determines which views prevent closing the window.
3558
+ + * Defaults to `all`. You may want to switch this to `layout` if using View closeBehavior: 'hide'.
3650
3559
  * **NOTE:** - This option is ignored in non-Platforms apps.
3651
3560
  */
3652
3561
  viewsPreventingClose: 'all' | 'layout';
@@ -4453,7 +4362,7 @@ declare type CreateViewPayload = {
4453
4362
  /**
4454
4363
  * @interface
4455
4364
  */
4456
- declare type CreateViewTarget = LayoutIdentity & {
4365
+ declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
4457
4366
  /**
4458
4367
  * If specified, view creation will not attach to a window and caller must
4459
4368
  * insert the view into the layout explicitly
@@ -4593,6 +4502,14 @@ declare type DestroyedEvent = BaseEvent_4 & {
4593
4502
  type: 'destroyed';
4594
4503
  };
4595
4504
 
4505
+ /**
4506
+ * @interface
4507
+ */
4508
+ declare type DeviceInfo = {
4509
+ vendorId: string | number;
4510
+ productId: string | number;
4511
+ };
4512
+
4596
4513
  /**
4597
4514
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
4598
4515
  * @interface
@@ -4834,7 +4751,7 @@ declare type DownloadShelfOptions = {
4834
4751
  */
4835
4752
  size?: number;
4836
4753
  /**
4837
- * Color of the border, either a string name or a hex code. Defaults to chromium theme
4754
+ * Color of the border. Must be a 6-character hex code prefixed by #. Defaults to chromium theme
4838
4755
  * if absent.
4839
4756
  */
4840
4757
  color?: string;
@@ -5053,9 +4970,10 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
5053
4970
  } : never;
5054
4971
 
5055
4972
  declare interface Environment {
5056
- initLayout(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
4973
+ initLayoutManager(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, wire: Transport, options: OpenFin_2.InitLayoutOptions): Promise<OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>>;
5057
4974
  createLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, options: OpenFin_2.CreateLayoutOptions): Promise<void>;
5058
4975
  destroyLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<void>;
4976
+ resolveLayout(layoutManager: OpenFin_2.LayoutManager<OpenFin_2.LayoutSnapshot>, layoutIdentity: OpenFin_2.LayoutIdentity): Promise<any>;
5059
4977
  initPlatform(fin: OpenFin_2.Fin<OpenFin_2.EntityType>, ...args: Parameters<OpenFin_2.Fin['Platform']['init']>): ReturnType<OpenFin_2.Fin['Platform']['init']>;
5060
4978
  observeBounds(element: Element, onChange: (bounds: DOMRect) => Promise<void> | void): () => void;
5061
4979
  writeToken(path: string, token: string): Promise<string>;
@@ -5277,7 +5195,7 @@ declare type EventType_7 = Event_10['type'];
5277
5195
  /**
5278
5196
  * Union of possible `type` values for a {@link SystemEvent}.
5279
5197
  */
5280
- declare type EventType_8 = SystemEvent['type'];
5198
+ declare type EventType_8 = Event_11['type'];
5281
5199
 
5282
5200
  /* Excluded from this release type: EventWithId */
5283
5201
 
@@ -5309,83 +5227,6 @@ declare type ExitCode = {
5309
5227
  declare class ExternalApplication extends EmitterBase<OpenFin_2.ExternalApplicationEvent> {
5310
5228
  identity: OpenFin_2.ApplicationIdentity;
5311
5229
  /* Excluded from this release type: __constructor */
5312
- /**
5313
- * Adds a listener to the end of the listeners array for the specified event.
5314
- * @param eventType - The type of the event.
5315
- * @param listener - Called whenever an event of the specified type occurs.
5316
- * @param options - Option to support event timestamps.
5317
- *
5318
- * @function addListener
5319
- * @memberof ExternalApplication
5320
- * @instance
5321
- * @tutorial ExternalApplication.EventEmitter
5322
- */
5323
- /**
5324
- * Adds a listener to the end of the listeners array for the specified event.
5325
- * @param eventType - The type of the event.
5326
- * @param listener - Called whenever an event of the specified type occurs.
5327
- * @param options - Option to support event timestamps.
5328
- *
5329
- * @function on
5330
- * @memberof ExternalApplication
5331
- * @instance
5332
- * @tutorial ExternalApplication.EventEmitter
5333
- */
5334
- /**
5335
- * 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.
5336
- * @param eventType - The type of the event.
5337
- * @param listener - The callback function.
5338
- * @param options - Option to support event timestamps.
5339
- *
5340
- * @function once
5341
- * @memberof ExternalApplication
5342
- * @instance
5343
- * @tutorial ExternalApplication.EventEmitter
5344
- */
5345
- /**
5346
- * Adds a listener to the beginning of the listeners array for the specified event.
5347
- * @param eventType - The type of the event.
5348
- * @param listener - The callback function.
5349
- * @param options - Option to support event timestamps.
5350
- *
5351
- * @function prependListener
5352
- * @memberof ExternalApplication
5353
- * @instance
5354
- * @tutorial ExternalApplication.EventEmitter
5355
- */
5356
- /**
5357
- * 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.
5358
- * The listener is added to the beginning of the listeners array.
5359
- * @param eventType - The type of the event.
5360
- * @param listener - The callback function.
5361
- * @param options - Option to support event timestamps.
5362
- *
5363
- * @function prependOnceListener
5364
- * @memberof ExternalApplication
5365
- * @instance
5366
- * @tutorial ExternalApplication.EventEmitter
5367
- */
5368
- /**
5369
- * Remove a listener from the listener array for the specified event.
5370
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5371
- * @param eventType - The type of the event.
5372
- * @param listener - The callback function.
5373
- * @param options - Option to support event timestamps.
5374
- *
5375
- * @function removeListener
5376
- * @memberof ExternalApplication
5377
- * @instance
5378
- * @tutorial ExternalApplication.EventEmitter
5379
- */
5380
- /**
5381
- * Removes all listeners, or those of the specified event.
5382
- * @param eventType - The type of the event.
5383
- *
5384
- * @function removeAllListeners
5385
- * @memberof ExternalApplication
5386
- * @instance
5387
- * @tutorial ExternalApplication.EventEmitter
5388
- */
5389
5230
  /**
5390
5231
  * Retrieves information about the external application.
5391
5232
  *
@@ -5801,83 +5642,6 @@ declare type FoundInPageEvent = NamedEvent & {
5801
5642
  declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5802
5643
  identity: OpenFin_2.Identity;
5803
5644
  /* Excluded from this release type: __constructor */
5804
- /**
5805
- * Adds the listener function to the end of the listeners array for the specified event type.
5806
- * @param eventType - The type of the event.
5807
- * @param listener - Called whenever an event of the specified type occurs.
5808
- * @param options - Option to support event timestamps.
5809
- *
5810
- * @function addListener
5811
- * @memberof Frame
5812
- * @instance
5813
- * @tutorial Frame.EventEmitter
5814
- */
5815
- /**
5816
- * Adds a listener to the end of the listeners array for the specified event.
5817
- * @param eventType - The type of the event.
5818
- * @param listener - Called whenever an event of the specified type occurs.
5819
- * @param options - Option to support event timestamps.
5820
- *
5821
- * @function on
5822
- * @memberof Frame
5823
- * @instance
5824
- * @tutorial Frame.EventEmitter
5825
- */
5826
- /**
5827
- * 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.
5828
- * @param eventType - The type of the event.
5829
- * @param listener - The callback function.
5830
- * @param options - Option to support event timestamps.
5831
- *
5832
- * @function once
5833
- * @memberof Frame
5834
- * @instance
5835
- * @tutorial Frame.EventEmitter
5836
- */
5837
- /**
5838
- * Adds a listener to the beginning of the listeners array for the specified event.
5839
- * @param eventType - The type of the event.
5840
- * @param listener - The callback function.
5841
- * @param options - Option to support event timestamps.
5842
- *
5843
- * @function prependListener
5844
- * @memberof Frame
5845
- * @instance
5846
- * @tutorial Frame.EventEmitter
5847
- */
5848
- /**
5849
- * 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.
5850
- * The listener is added to the beginning of the listeners array.
5851
- * @param eventType - The type of the event.
5852
- * @param listener - The callback function.
5853
- * @param options - Option to support event timestamps.
5854
- *
5855
- * @function prependOnceListener
5856
- * @memberof Frame
5857
- * @instance
5858
- * @tutorial Frame.EventEmitter
5859
- */
5860
- /**
5861
- * Remove a listener from the listener array for the specified event.
5862
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
5863
- * @param eventType - The type of the event.
5864
- * @param listener - The callback function.
5865
- * @param options - Option to support event timestamps.
5866
- *
5867
- * @function removeListener
5868
- * @memberof Frame
5869
- * @instance
5870
- * @tutorial Frame.EventEmitter
5871
- */
5872
- /**
5873
- * Removes all listeners, or those of the specified event.
5874
- * @param eventType - The type of the event.
5875
- *
5876
- * @function removeAllListeners
5877
- * @memberof Frame
5878
- * @instance
5879
- * @tutorial Frame.EventEmitter
5880
- */
5881
5645
  /**
5882
5646
  * Returns a frame info object for the represented frame.
5883
5647
  *
@@ -6796,6 +6560,8 @@ declare type InitPlatformOptions = {
6796
6560
  interopOverride?: OverrideCallback<InteropBroker> | ConstructorOverride<InteropBroker>[];
6797
6561
  };
6798
6562
 
6563
+ declare type InjectionType = 'none' | 'global';
6564
+
6799
6565
  /**
6800
6566
  * Generated when the value of the element changes.
6801
6567
  * @interface
@@ -7140,56 +6906,6 @@ declare class InteropBroker extends Base {
7140
6906
  static createClosedConstructor(...args: ConstructorParameters<typeof InteropBroker>): {
7141
6907
  new (): InteropBroker;
7142
6908
  };
7143
- /**
7144
- * @REMOVED
7145
- * SetContextOptions interface
7146
- * @typedef { object } SetContextOptions@typedef { object } SetContextOptions
7147
- * @property { Context } {context} - New context to set.
7148
- */
7149
- /**
7150
- * @REMOVED
7151
- * GetContextOptions interface
7152
- * @typedef { object } GetContextOptions@typedef { object } GetContextOptions
7153
- * @property { string } [contextType] - Context Type
7154
- */
7155
- /**
7156
- * @REMOVED
7157
- * JoinContextGroupOptions interface
7158
- * @typedef { object } JoinContextGroupOptions@typedef { object } JoinContextGroupOptions
7159
- * @property { string } contextGroupId - Id of the context group.
7160
- * @property { Identity | ClientIdentity } [target] - Identity of the entity you wish to join to a context group.
7161
- */
7162
- /**
7163
- * @REMOVED
7164
- * AddClientToContextGroupOptions interface
7165
- * @typedef { object } AddClientToContextGroupOptions@typedef { object } AddClientToContextGroupOptions
7166
- * @property { string } contextGroupId - Name of the context group.
7167
- */
7168
- /**
7169
- * @REMOVED
7170
- * RemoveFromContextGroupOptions interface
7171
- * @typedef { object } RemoveFromContextGroupOptions@typedef { object } RemoveFromContextGroupOptions
7172
- * @property { Identity | ClientIdentity } target - Identity of the entity you wish to join to a context group.
7173
- */
7174
- /**
7175
- * @REMOVED
7176
- * GetInfoForContextGroupOptions interface
7177
- * @typedef { object } GetInfoForContextGroupOptions@typedef { object } GetInfoForContextGroupOptions
7178
- * @property { string } contextGroupId - Name of the context group to get info for.
7179
- */
7180
- /**
7181
- * @REMOVED
7182
- * GetAllClientsInContextGroupOptions interface
7183
- * @typedef { object } GetAllClientsInContextGroupOptions@typedef { object } GetAllClientsInContextGroupOptions
7184
- * @property { string } contextGroupId - Name of the context group to get info for.
7185
- */
7186
- /**
7187
- * @PORTED
7188
- * InfoForIntentOptions interface
7189
- * @typedef { object } InfoForIntentOptions@typedef { object } InfoForIntentOptions
7190
- * @property { string } name Name of the intent to get info for.
7191
- * @property { Context } [context] Optional context.
7192
- */
7193
6909
  /**
7194
6910
  * Sets a context for the context group of the incoming current entity.
7195
6911
  * @param setContextOptions - New context to set.
@@ -7433,7 +7149,7 @@ declare class InteropBroker extends Base {
7433
7149
  * // }
7434
7150
  * ```
7435
7151
  *
7436
- * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
7152
+ * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/Metadata#intentresolution).
7437
7153
  *
7438
7154
  * @param contextForIntent Data passed between entities and applications.
7439
7155
  * @param clientIdentity Identity of the Client making the request.
@@ -7689,95 +7405,6 @@ declare type InteropBrokerOptions = {
7689
7405
  logging?: InteropLoggingOptions;
7690
7406
  };
7691
7407
 
7692
- /**
7693
- * @PORTED
7694
- * @typedef { object } Intent
7695
- * @summary The combination of an action and a context that is passed to an application for resolution.
7696
- * @property { string } name Name of the intent.
7697
- * @property { Context } context Data associated with the intent
7698
- */
7699
- /**
7700
- * @REMOVED
7701
- * @typedef { object } Subscription
7702
- * @summary Object returned when subscribing a handler.
7703
- * @property { function } unsubscribe Function to unsubscribe the handler.
7704
- */
7705
- /**
7706
- * @typedef { function } ContextHandler
7707
- * @summary Subscription function for addContextHandler.
7708
- */
7709
- /**
7710
- * @typedef { function } IntentHandler
7711
- * @summary Subscription function for registerIntentHandler
7712
- */
7713
- /**
7714
- * @PORTED
7715
- * @typedef { object } ClientIdentity
7716
- * @summary The Identity for a Channel Client. Includes endpointId to differentiate between different connections for an entity.
7717
- * @property {string} uuid GUID of an application.
7718
- * @property {string} name Name of an entity in an application.
7719
- * @property {string} endpointId Unique differentiator for different Channel connections for an entity.
7720
- */
7721
- /**
7722
- * @PORTED
7723
- * @typedef { object } ContextGroupInfo
7724
- * @summary Information for a Context Group. Contains metadata for displaying the group properly.
7725
- * @property {string} id Name of the context group
7726
- * @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.
7727
- */
7728
- /**
7729
- * @PORTED
7730
- * @typedef { object } DisplayMetadata
7731
- * @summary The display data for a Context Group.
7732
- * @property {string} name A user-readable name for this context group, e.g: `"Red"`
7733
- * @property {string} [color] The color that should be associated within this context group when displaying this context group in a UI, e.g: `0xFF0000`.
7734
- * @property {string} [glyph] A URL of an image that can be used to display this context group
7735
- */
7736
- /**
7737
- * @PORTED
7738
- * @typedef { object } Context
7739
- * @summary Data passed between entities and applications.
7740
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7741
- * @property {string} [name] User-readable name for the incoming context.
7742
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7743
- */
7744
- /**
7745
- * @REMOVED
7746
- * @typedef { object } ContextForIntent
7747
- * @summary Data passed between entities and applications, including an optional metadata.
7748
- * @property {object} [id] An object containing string key-value pairs for the bulk of the data for the context. Differs between context types.
7749
- * @property {string} [name] User-readable name for the incoming context.
7750
- * @property {string} type Conserved type for the context (e.g. `instrument` or `country`)
7751
- * @property {any} [metadata]
7752
- */
7753
- /**
7754
- * @REMOVED
7755
- * @typedef { object } SessionContextGroup
7756
- * @summary An instance of a SessionContextGroup
7757
- * @property {string} id The SessionContextGroup's id.
7758
- * @property {setContext} setContext Sets a context of a certain type
7759
- * @property {getCurrentContext} getCurrentContext Gets the currently set context of a certain type
7760
- * @property {addContextHandler} addContextHandler Adds a handler for context change.
7761
- */
7762
- /**
7763
- * @typedef {function} setContext
7764
- * @summary A SessionContextGroup instance method for setting a context in the SessionContextGroup.
7765
- * @param context The Context to be set.
7766
- *
7767
- */
7768
- /**
7769
- * @typedef {function} getCurrentContext
7770
- * @summary A SessionContextGroup instance method for getting the current context of a certain type.
7771
- * @param contextType The Context Type to get. If not specified the last contextType set would get used.
7772
- *
7773
- */
7774
- /**
7775
- * @typedef {function} addContextHandler
7776
- * @summary A SessionContextGroup instance method for adding a handler for context change.
7777
- * @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.
7778
- * @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.
7779
- *
7780
- */
7781
7408
  /**
7782
7409
  * {@link https://developers.openfin.co/of-docs/docs/enable-color-linking}
7783
7410
  *
@@ -8213,13 +7840,6 @@ declare type InteropLoggingActions = 'beforeAction' | 'afterAction';
8213
7840
  */
8214
7841
  declare type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
8215
7842
 
8216
- /**
8217
- * @PORTED
8218
- * @typedef { object } InteropConfig
8219
- * @summary Information relevant to the Interop Broker.
8220
- * @property {string} [currentContextGroup] Context Group for the client. (green, yellow, red, etc.)
8221
- * @property {string} [providerId] When provided, automatically connects the client to the specified provider uuid
8222
- */
8223
7843
  /**
8224
7844
  * Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.
8225
7845
  *
@@ -8607,7 +8227,7 @@ declare type LaunchIntoPlatformPayload = {
8607
8227
  declare class Layout extends Base {
8608
8228
  #private;
8609
8229
  /* Excluded from this release type: init */
8610
- identity: OpenFin_2.LayoutIdentity;
8230
+ identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity;
8611
8231
  private platform;
8612
8232
  wire: Transport;
8613
8233
  /* Excluded from this release type: __constructor */
@@ -8823,25 +8443,24 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
8823
8443
  */
8824
8444
  declare type LayoutIdentity = Identity_5 & {
8825
8445
  /**
8826
- * The name of the layout an action should be targeted to. When not provided,
8827
- * OpenFin attempts to resolve the instance via visibility checks.
8446
+ * The name of the layout in a given window.
8828
8447
  */
8829
- layoutName?: string;
8448
+ layoutName: string;
8830
8449
  };
8831
8450
 
8832
8451
  /**
8833
- * Generated when a window and all of its layout's views have either finished or failed navigation.
8452
+ * Generated when the window is created, and all of its layout's views have either finished or failed
8453
+ * navigation, once per layout. Does not emit for any layouts added via Layout.create() call.
8834
8454
  * @interface
8835
8455
  */
8836
8456
  declare type LayoutInitializedEvent = BaseEvent_5 & {
8837
8457
  type: 'layout-initialized';
8458
+ layoutIdentity: OpenFin_2.LayoutIdentity;
8838
8459
  ofViews: (OpenFin_2.Identity & {
8839
8460
  entityType: 'view';
8840
8461
  })[];
8841
8462
  };
8842
8463
 
8843
- /* Excluded from this release type: LayoutInstance */
8844
-
8845
8464
  /**
8846
8465
  * Represents the arrangement of Views within a Platform window's Layout. We do not recommend trying
8847
8466
  * to build Layouts or LayoutItems by hand and instead use calls such as {@link Platform#getSnapshot getSnapshot}.
@@ -8869,7 +8488,7 @@ declare type LayoutItemConfig = {
8869
8488
  *
8870
8489
  * **NOTE**: Internal use only. This type is reserved for Workspace Browser implementation.
8871
8490
  *
8872
- * Responsible for aggergating all layout snapshots and storing LayoutInstances
8491
+ * Responsible for aggregating all layout snapshots and storing layout instances
8873
8492
  */
8874
8493
  declare interface LayoutManager<T extends LayoutSnapshot> {
8875
8494
  /**
@@ -8893,16 +8512,6 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8893
8512
  * @throws if Object.keys(snapshot).length > 1
8894
8513
  */
8895
8514
  applyLayoutSnapshot(snapshot: T): Promise<void>;
8896
- /**
8897
- * Called at the start of layout initialization. Adds a new LayoutInstance if the snapshot
8898
- * contains a single layout.
8899
- *
8900
- * Throws if the snapshot contains more than 1 layout, it is expected that the user handles calling
8901
- * fin.Platform.Layout.create() once for each layout to properly connect it to their UI state.
8902
- *
8903
- * @param snapshot
8904
- * @throws if Object.keys(snapshot).length > 1
8905
- */
8906
8515
  /**
8907
8516
  * @experimental
8908
8517
  *
@@ -8923,31 +8532,49 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
8923
8532
  /**
8924
8533
  * @experimental
8925
8534
  *
8926
- * @param layoutIdentity
8927
- * @returns
8535
+ * A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
8536
+ * this method to control the target layout for Layout API calls.
8537
+ *
8538
+ * Example use case: You have hidden all the layouts and are showing a dialog that will
8539
+ * execute an API call (ex: Layout.replace()) - override this method and save the
8540
+ * "last visible" layout identity and return it.
8541
+ *
8542
+ * By default, OpenFin will use a series of checks to determine which Layout the API
8543
+ * call must route to in this order of precedence:
8544
+ * - try to resolve the layout from the layoutIdentity, throws if missing
8545
+ * - if there is only 1 layout, resolves that one
8546
+ * - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
8547
+ * - returns undefined
8548
+ *
8549
+ * @param identity
8550
+ * @returns LayoutIdentity | undefined
8928
8551
  */
8929
- resolveLayout(layoutIdentity?: LayoutIdentity): Promise<LayoutInstance>;
8552
+ resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
8930
8553
  /**
8931
8554
  * @experimental
8932
8555
  *
8933
- * Returns a LayoutInstance if one exists with the name layoutIdentity.layoutName.
8934
- * Throws if it does not exist.
8935
- * @param layoutName
8936
- * @returns
8556
+ * A hook provided to the consumer when it's time to remove a layout. Use this hook to
8557
+ * update your local state and remove the layout for the given LayoutIdentity. Note that
8558
+ * this hook does not call `fin.Platform.Layout.destroy()` for you, instead it is to
8559
+ * signify to your application it's time to destroy this layout.
8560
+ *
8561
+ * Note that if the Window Option {@link WindowOptions.closeOnLastViewRemoved} is true, and the last View in this layout is closed, this hook will be called before the window closes.
8562
+ *
8563
+ * @param LayoutIdentity
8937
8564
  */
8938
- getLayoutByName(layoutName: string): LayoutInstance;
8565
+ removeLayout({ layoutName }: LayoutIdentity): Promise<void>;
8939
8566
  /**
8940
8567
  * @experimental
8941
8568
  */
8942
- getLayouts(): Record<string, LayoutInstance>;
8569
+ getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8943
8570
  /**
8944
8571
  * @experimental
8945
8572
  */
8946
- getLayoutIdentityForView(viewIdentity: Identity_5): LayoutIdentity;
8573
+ isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8947
8574
  /**
8948
8575
  * @experimental
8949
8576
  */
8950
- isLayoutVisible({ layoutName }: LayoutIdentity): boolean;
8577
+ size(): number;
8951
8578
  }
8952
8579
 
8953
8580
  /**
@@ -8994,7 +8621,7 @@ declare class LayoutModule extends Base {
8994
8621
  * const layoutConfig = await layout.getConfig();
8995
8622
  * ```
8996
8623
  */
8997
- wrap(identity: OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
8624
+ wrap(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): Promise<OpenFin_2.Layout>;
8998
8625
  /**
8999
8626
  * Synchronously returns a Layout object that represents a Window's layout.
9000
8627
  *
@@ -9014,7 +8641,7 @@ declare class LayoutModule extends Base {
9014
8641
  * const layoutConfig = await layout.getConfig();
9015
8642
  * ```
9016
8643
  */
9017
- wrapSync(identity: OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
8644
+ wrapSync(identity: OpenFin_2.Identity | OpenFin_2.LayoutIdentity): OpenFin_2.Layout;
9018
8645
  /**
9019
8646
  * Asynchronously returns a Layout object that represents a Window's layout.
9020
8647
  *
@@ -9111,7 +8738,7 @@ declare type LayoutOptions = {
9111
8738
  * @defaultValue false
9112
8739
  *
9113
8740
  * Limits the area to which tabs can be dragged.
9114
- * If true, stack headers are the only areas where tabs can be dropped.
8741
+ * If true, the layout container is the only area where tabs can be dropped.
9115
8742
  */
9116
8743
  constrainDragToContainer?: boolean;
9117
8744
  /**
@@ -9182,6 +8809,9 @@ declare type LayoutOptions = {
9182
8809
  };
9183
8810
  };
9184
8811
 
8812
+ /**
8813
+ * Represents the position of an item in a layout relative to another.
8814
+ */
9185
8815
  declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9186
8816
 
9187
8817
  /**
@@ -9190,11 +8820,12 @@ declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
9190
8820
  declare type LayoutPresetType = 'columns' | 'grid' | 'rows' | 'tabs';
9191
8821
 
9192
8822
  /**
9193
- * Generated when a window and all of its layout's views have been created and can receive API calls.
8823
+ * Generated when the layout and all of the its views have been created and can receive API calls.
9194
8824
  * @interface
9195
8825
  */
9196
8826
  declare type LayoutReadyEvent = BaseEvent_5 & {
9197
8827
  type: 'layout-ready';
8828
+ layoutIdentity: OpenFin_2.LayoutIdentity;
9198
8829
  views: (OpenFin_2.Identity & {
9199
8830
  success: boolean;
9200
8831
  })[];
@@ -9899,7 +9530,7 @@ declare type MutableWindowOptions = {
9899
9530
  showTaskbarIcon: boolean;
9900
9531
  interop: InteropConfig;
9901
9532
  /* Excluded from this release type: _internalWorkspaceData */
9902
- workspacePlatform: WorkspacePlatformOptions;
9533
+ workspacePlatform: unknown;
9903
9534
  };
9904
9535
 
9905
9536
  declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
@@ -10087,6 +9718,7 @@ declare namespace OpenFin_2 {
10087
9718
  ResizeRegion,
10088
9719
  Accelerator,
10089
9720
  Api,
9721
+ InjectionType,
10090
9722
  NavigationRules,
10091
9723
  ContentNavigation,
10092
9724
  ContentRedirect,
@@ -10132,6 +9764,7 @@ declare namespace OpenFin_2 {
10132
9764
  WebPermission,
10133
9765
  VerboseWebPermission,
10134
9766
  OpenExternalPermission,
9767
+ DeviceInfo,
10135
9768
  Permissions_2 as Permissions,
10136
9769
  PlatformWindowCreationOptions,
10137
9770
  PlatformWindowOptions,
@@ -10289,7 +9922,6 @@ declare namespace OpenFin_2 {
10289
9922
  InitLayoutOptions,
10290
9923
  LayoutManagerConstructor,
10291
9924
  LayoutManagerOverride,
10292
- LayoutInstance,
10293
9925
  LayoutManager,
10294
9926
  CreateLayoutOptions,
10295
9927
  PresetLayoutOptions_2 as PresetLayoutOptions,
@@ -10481,6 +10113,7 @@ declare type Permissions_2 = {
10481
10113
  Application?: Partial<ApplicationPermissions>;
10482
10114
  System?: Partial<SystemPermissions>;
10483
10115
  webAPIs?: WebPermission[];
10116
+ devices?: DeviceInfo[];
10484
10117
  };
10485
10118
 
10486
10119
  declare type PermissionState_2 = 'granted' | 'denied' | 'unavailable';
@@ -11393,7 +11026,17 @@ declare interface PlatformProvider {
11393
11026
  */
11394
11027
  getSnapshot(payload: undefined, identity: OpenFin_2.Identity): Promise<OpenFin_2.Snapshot>;
11395
11028
  /* Excluded from this release type: getInitialLayoutSnapshot */
11396
- /* Excluded from this release type: createViewsForLayout */
11029
+ /**
11030
+ * @experimental
11031
+ *
11032
+ * This API is called during the {@link PlatformProvider.getSnapshot()} call.
11033
+ * Gets the current state of a particular window and its views and returns an object that
11034
+ * can be added to the {@link OpenFin.Snapshot.windows} property. Override this function if
11035
+ * you wish to mutate each window snapshot during the {@link PlatformProvider.getSnapshot()} call
11036
+ * @param identity
11037
+ * @param callerIdentity
11038
+ */
11039
+ getWindowSnapshot(identity: OpenFin_2.Identity, callerIdentity: OpenFin_2.Identity): Promise<OpenFin_2.WindowCreationOptions>;
11397
11040
  /* Excluded from this release type: getViewSnapshot */
11398
11041
  /**
11399
11042
  * Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
@@ -12821,7 +12464,7 @@ declare type ReplaceLayoutPayload = {
12821
12464
  /**
12822
12465
  * Identity of the window whose layout will be replaced.
12823
12466
  */
12824
- target: LayoutIdentity;
12467
+ target: Identity_5 | LayoutIdentity;
12825
12468
  };
12826
12469
 
12827
12470
  /**
@@ -13652,83 +13295,6 @@ declare type SubscriptionOptions = {
13652
13295
  declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
13653
13296
  /* Excluded from this release type: __constructor */
13654
13297
  private sendExternalProcessRequest;
13655
- /**
13656
- * Adds a listener to the end of the listeners array for the specified event.
13657
- * @param eventType - The type of the event.
13658
- * @param listener - Called whenever an event of the specified type occurs.
13659
- * @param options - Option to support event timestamps.
13660
- *
13661
- * @function addListener
13662
- * @memberof System
13663
- * @instance
13664
- * @tutorial System.EventEmitter
13665
- */
13666
- /**
13667
- * Adds a listener to the end of the listeners array for the specified event.
13668
- * @param eventType - The type of the event.
13669
- * @param listener - Called whenever an event of the specified type occurs.
13670
- * @param options - Option to support event timestamps.
13671
- *
13672
- * @function on
13673
- * @memberof System
13674
- * @instance
13675
- * @tutorial System.EventEmitter
13676
- */
13677
- /**
13678
- * 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.
13679
- * @param eventType - The type of the event.
13680
- * @param listener - The callback function.
13681
- * @param options - Option to support event timestamps.
13682
- *
13683
- * @function once
13684
- * @memberof System
13685
- * @instance
13686
- * @tutorial System.EventEmitter
13687
- */
13688
- /**
13689
- * Adds a listener to the beginning of the listeners array for the specified event.
13690
- * @param eventType - The type of the event.
13691
- * @param listener - The callback function.
13692
- * @param options - Option to support event timestamps.
13693
- *
13694
- * @function prependListener
13695
- * @memberof System
13696
- * @instance
13697
- * @tutorial System.EventEmitter
13698
- */
13699
- /**
13700
- * 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.
13701
- * The listener is added to the beginning of the listeners array.
13702
- * @param eventType - The type of the event.
13703
- * @param listener - The callback function.
13704
- * @param options - Option to support event timestamps.
13705
- *
13706
- * @function prependOnceListener
13707
- * @memberof System
13708
- * @instance
13709
- * @tutorial System.EventEmitter
13710
- */
13711
- /**
13712
- * Remove a listener from the listener array for the specified event.
13713
- * Caution: Calling this method changes the array indices in the listener array behind the listener.
13714
- * @param eventType - The type of the event.
13715
- * @param listener - The callback function.
13716
- * @param options - Option to support event timestamps.
13717
- *
13718
- * @function removeListener
13719
- * @memberof System
13720
- * @instance
13721
- * @tutorial System.EventEmitter
13722
- */
13723
- /**
13724
- * Removes all listeners, or those of the specified event.
13725
- * @param eventType - The type of the event.
13726
- *
13727
- * @function removeAllListeners
13728
- * @memberof System
13729
- * @instance
13730
- * @tutorial System.EventEmitter
13731
- */
13732
13298
  /**
13733
13299
  * Returns the version of the runtime. The version contains the major, minor,
13734
13300
  * build and revision numbers.
@@ -15312,20 +14878,6 @@ declare interface TabDragListener extends EventEmitter_2 {
15312
14878
  contentItem: ContentItem;
15313
14879
  }
15314
14880
 
15315
- /**
15316
- * @typedef {string} LayoutPosition
15317
- * @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
15318
- */
15319
- /**
15320
- * @typedef {object} StackCreationOptions
15321
- * @summary Stack creation options.
15322
- * @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
15323
- */
15324
- /**
15325
- * @typedef {object} TabStack~AddViewOptions
15326
- * @summary Options to use when adding a view to a {@link TabStack}
15327
- * @property {number} [index] - Insertion index when adding the view. Defaults to 0.
15328
- */
15329
14881
  /**
15330
14882
  * A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
15331
14883
  */
@@ -15771,175 +15323,12 @@ declare type VerboseWebPermission = {
15771
15323
  declare type View = OpenFin_2.View;
15772
15324
 
15773
15325
  /**
15774
- * @PORTED
15775
- * @typedef {object} View~options
15776
- * @summary View creation options.
15777
- * @desc This is the options object required by {@link View.create View.create}.
15778
- *
15779
- * Note that `name` and `target` are the only required properties — albeit the `url` property is usually provided as well
15780
- * (defaults to `"about:blank"` when omitted).
15781
- *
15782
- * @property {object} [experimental]
15783
- * Configurations for API injection.
15784
- *
15785
- * @property {boolean} [experimental.childWindows] Configure if the runtime should enable child windows for views.
15786
- *
15787
- * @property {object} [accelerator]
15788
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
15789
- *
15790
- * @property {boolean} [accelerator.devtools=false]
15791
- * If `true`, enables the devtools keyboard shortcut:<br>
15792
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
15793
- *
15794
- * @property {boolean} [accelerator.reload=false]
15795
- * If `true`, enables the reload keyboard shortcuts:<br>
15796
- * `Ctrl` + `R` _(Windows)_<br>
15797
- * `F5` _(Windows)_<br>
15798
- * `Command` + `R` _(Mac)_
15799
- *
15800
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
15801
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
15802
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
15803
- * `Shift` + `F5` _(Windows)_<br>
15804
- * `Command` + `Shift` + `R` _(Mac)_
15805
- *
15806
- * @property {boolean} [accelerator.zoom=false]
15807
- * If `true`, enables the zoom keyboard shortcuts:<br>
15808
- * `Ctrl` + `+` _(Zoom In)_<br>
15809
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
15810
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
15811
- * `Ctrl` + `-` _(Zoom Out)_<br>
15812
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
15813
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
15814
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
15815
- * `Ctrl` + `0` _(Restore to 100%)_
15816
- *
15817
- * @property {object} [api]
15818
- * Configurations for API injection.
15819
- *
15820
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
15821
- *
15822
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
15823
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
15824
- *
15825
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
15826
- * Autoplay policy to apply to content in the window, can be
15827
- * `no-user-gesture-required`, `user-gesture-required`,
15828
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
15829
- *
15830
- * @property {object} [autoResize] AutoResize options
15831
- *
15832
- * @property {object} [bounds] initial bounds given relative to the window.
15833
- *
15834
- * @property {string} [backgroundColor="#FFF"] - _Updatable._
15835
- * The view’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
15836
- * (`document.body.style.backgroundColor`),
15837
- * this color briefly fills a view’s (a) content area before its content is loaded as well as (b) newly exposed
15838
- * areas when growing a window. Setting
15839
- * this value to the anticipated content background color can help improve user experience.
15840
- * Default is white.
15841
- *
15842
- * @property {object} [contentNavigation]
15843
- * Restrict navigation to URLs that match an allowed pattern.
15844
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
15845
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15846
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
15847
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
15848
- *
15849
- * @property {object} [contentRedirect]
15850
- * Restrict redirects to URLs that match an allowed pattern.
15851
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
15852
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
15853
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
15854
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
15855
- *
15856
- * @property {object} [contextMenuSettings] - _Updatable._
15857
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
15858
- * Configure the context menu when right-clicking on a view.
15859
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
15860
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
15861
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
15862
- *
15863
- * @property {object} [contextMenuOptions] - _Updatable._
15864
- * Configure the context menu when right-clicking on a view. Supported menu items:
15865
- * 'separator'
15866
- * 'cut'
15867
- * 'copy'
15868
- * 'copyImage',
15869
- * 'paste'
15870
- * 'spellCheck'
15871
- * 'inspect'
15872
- * 'reload'
15873
- * 'navigateForward'
15874
- * 'navigateBack'
15875
- * 'print'
15876
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
15877
- * @property {string[]} [contextMenuOptions.template=[]] List of context menu items to display on right-click.
15878
- *
15879
- * @property {any} [customData=""] - _Updatable._
15880
- * A field that the user can attach serializable data to be ferried around with the view options.
15881
- * _When omitted, the default value of this property is the empty string (`""`)._
15326
+ * A View can be used to embed additional web content into a Window.
15327
+ * It is like a child window, except it is positioned relative to its owning window.
15328
+ * It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
15882
15329
  *
15883
- * @property {any} [customContext=""] - _Updatable._
15884
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
15885
- * is called.
15886
- * When omitted, the default value of this property is the empty string (`""`).
15887
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
15888
- *
15889
- * @property {object[]} [hotkeys=[]] - _Updatable._
15890
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the view. For usage example see [example]{@tutorial hotkeys}.
15891
- * Within Platform, OpenFin also implements a set of pre-defined actions called
15892
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
15893
- * that can be assigned to a specific hotkey in the platform manifest.
15894
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
15895
- * @property {boolean} [hotkeys.preventDefault=false] preventDefault will prevent the page keydown/keyup events from being emitted.
15896
- *
15897
- * @property {boolean} [isClosable=true] **Platforms Only.** If false, the view will be persistent and can't be closed through
15898
- * either UI or `Platform.closeView`. Note that the view will still be closed if the host window is closed or
15899
- * if the view isn't part of the new layout when running `Layout.replace`.
15900
- *
15901
- * @property {string} name
15902
- * The name of the view.
15903
- *
15904
- * @property {boolean} [detachOnClose=false] - _Updatable._
15905
- * Platforms Only. If true, will hide and detach the View from the window for later use instead of closing,
15906
- * allowing the state of the View to be saved and the View to be immediately shown in a new Layout.
15907
- *
15908
- * @property {string} [manifestUrl] **Platforms Only.** Url to a manifest that contains View Options. Properties other than manifestUrl can still be used
15909
- * but the properties in the manifest will take precedence if there is any collision.
15910
- *
15911
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
15912
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
15913
- * from the parent application.
15914
- *
15915
- * @property {boolean} [preventDragOut=false] **Platforms Only.** If true, the tab of the view can't be dragged out of its host window.
15916
- *
15917
- * @property {string} [processAffinity=<application uuid>]
15918
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
15919
- *
15920
- * @property {boolean} [spellCheck=false]
15921
- * Enable spell check in input text fields for the view.
15922
- *
15923
- * @property {Identity} [target]
15924
- * The identity of the window this view should be attached to.
15925
- *
15926
- * @property {string} [url="about:blank"]
15927
- * The URL of the view.
15928
- *
15929
- * @property {string} [uuid=<application uuid>]
15930
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
15931
- * If omitted, defaults to the `uuid` of the application spawning the view.
15932
- * If given, must match the `uuid` of the application spawning the view.
15933
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
15934
- * really no need to provide it.
15935
- */
15936
- /**
15937
- * A View can be used to embed additional web content into a Window.
15938
- * It is like a child window, except it is positioned relative to its owning window.
15939
- * It has the ability to listen for {@link OpenFin.ViewEvents View-specific events}.
15940
- *
15941
- * By default, a View will try to share the same renderer process as other Views owned by its parent Application.
15942
- * To change that behavior, see the processAffinity {@link OpenFin.ViewOptions view option}.
15330
+ * By default, a View will try to share the same renderer process as other Views owned by its parent Application.
15331
+ * To change that behavior, see the processAffinity {@link OpenFin.ViewOptions view option}.
15943
15332
  *
15944
15333
  * A View's lifecycle is tied to its owning window and can be re-attached to a different window at any point during its lifecycle.
15945
15334
  */
@@ -16411,7 +15800,7 @@ declare type ViewCreationOrReference = OpenFin_2.Identity | OpenFin_2.PlatformVi
16411
15800
  */
16412
15801
  declare type ViewDetachedEvent = BaseEvent_5 & {
16413
15802
  type: 'view-detached';
16414
- target: OpenFin_2.Identity;
15803
+ target: OpenFin_2.Identity | null;
16415
15804
  previousTarget: OpenFin_2.Identity;
16416
15805
  viewIdentity: OpenFin_2.Identity;
16417
15806
  };
@@ -17647,7 +17036,7 @@ declare namespace WebContentsEvents {
17647
17036
  * `clipboard-read`: Request access to read from the clipboard.<br>
17648
17037
  * `clipboard-sanitized-write`: Request access to write to the clipboard.
17649
17038
  */
17650
- declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | OpenExternalPermission;
17039
+ declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
17651
17040
 
17652
17041
  /**
17653
17042
  * Object representing headers and their values, where the
@@ -17725,476 +17114,6 @@ declare type WillResizeEvent = WillMoveOrResizeEvent & {
17725
17114
  type: 'will-resize';
17726
17115
  };
17727
17116
 
17728
- /**
17729
- * @PORTED
17730
- * @typedef { object } Margins@typedef { object } Margins
17731
- * @property { string } [marginType]
17732
- * Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen,
17733
- * you will also need to specify `top`, `bottom`, `left`, and `right`.
17734
- *
17735
- * @property { number } [top] The top margin of the printed web page, in pixels.
17736
- * @property { number } [bottom] The bottom margin of the printed web page, in pixels.
17737
- * @property { number } [left] The left margin of the printed web page, in pixels.
17738
- * @property { number } [right] The right margin of the printed web page, in pixels.
17739
- */
17740
- /**
17741
- * @PORTED
17742
- * @typedef { object } Dpi@typedef { object } Dpi
17743
- * @property { number } [horizontal] The horizontal dpi
17744
- * @property { number } [vertical] The vertical dpi
17745
- */
17746
- /**
17747
- * @PORTED
17748
- * @typedef { object } PrintOptions@typedef { object } PrintOptions
17749
- * @property { boolean } [silent=false] Don't ask user for print settings.
17750
- * @property { boolean } [printBackground=false] Prints the background color and image of the web page.
17751
- * @property { string } [deviceName=''] Set the printer device name to use.
17752
- * @property { boolean } [color=true] Set whether the printed web page will be in color or grayscale.
17753
- * @property { Margins } [margins] Set margins for the printed web page
17754
- * @property { boolean } [landscape=false] Whether the web page should be printed in landscape mode.
17755
- * @property { number } [scaleFactor] The scale factor of the web page.
17756
- * @property { number } [pagesPerSheet] The number of pages to print per page sheet.
17757
- * @property { boolean } [collate] Whether the web page should be collated.
17758
- * @property { number } [copies] The number of copies of the web page to print.
17759
- * @property { Record<string, number> } [pageRanges] The page range to print. Should have two keys: from and to.
17760
- * @property { string } [duplexMode] Set the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge.
17761
- * @property { Dpi } [dpi] Set dpi for the printed web page
17762
- */
17763
- /**
17764
- * @REMOVED
17765
- * PrinterInfo interface
17766
- * @typedef { object } PrinterInfo@typedef { object } PrinterInfo
17767
- * @property { string } name Printer Name
17768
- * @property { string } description Printer Description
17769
- * @property { number } status Printer Status
17770
- * @property { boolean } isDefault Indicates that system's default printer
17771
- */
17772
- /**
17773
- * @REMOVED
17774
- * SharedWorkerInfo interface
17775
- * @typedef { object } SharedWorkerInfo@typedef { object } SharedWorkerInfo
17776
- * @property { string } id The unique id of the shared worker.
17777
- * @property { string } url The url of the shared worker.
17778
- */
17779
- /**
17780
- * @PORTED
17781
- * ContentCreationRule interface
17782
- * @typedef { object } ContentCreationRule@typedef { object } ContentCreationRule
17783
- * @property { string } behavior 'view' | 'window' | 'browser' | 'block'
17784
- * @property { string[] } match List of [match patterns](https://developer.chrome.com/extensions/match_patterns).
17785
- * @property { object } options Window creation options or View creation options.
17786
- */
17787
- /**
17788
- * @PORTED
17789
- * @typedef {object} Window~options
17790
- * @summary Window creation options.
17791
- * @desc This is the options object required by {@link Window.create Window.create}.
17792
- *
17793
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
17794
- * (defaults to `"about:blank"` when omitted).
17795
- *
17796
- * _This jsdoc typedef mirrors the `WindowOptions` TypeScript interface in `@types/openfin`._
17797
- *
17798
- * @property {object} [accelerator]
17799
- * Enable keyboard shortcuts for devtools, zoom, reload, and reload ignoring cache.
17800
- *
17801
- * @property {boolean} [accelerator.devtools=false]
17802
- * If `true`, enables the devtools keyboard shortcut:<br>
17803
- * `Ctrl` + `Shift` + `I` _(Toggles Devtools)_
17804
- *
17805
- * @property {boolean} [accelerator.reload=false]
17806
- * If `true`, enables the reload keyboard shortcuts:<br>
17807
- * `Ctrl` + `R` _(Windows)_<br>
17808
- * `F5` _(Windows)_<br>
17809
- * `Command` + `R` _(Mac)_
17810
- *
17811
- * @property {boolean} [accelerator.reloadIgnoringCache=false]
17812
- * If `true`, enables the reload-from-source keyboard shortcuts:<br>
17813
- * `Ctrl` + `Shift` + `R` _(Windows)_<br>
17814
- * `Shift` + `F5` _(Windows)_<br>
17815
- * `Command` + `Shift` + `R` _(Mac)_
17816
- *
17817
- * @property {boolean} [accelerator.zoom=false]
17818
- * 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.
17819
- * If `true`, enables the zoom keyboard shortcuts:<br>
17820
- * `Ctrl` + `+` _(Zoom In)_<br>
17821
- * `Ctrl` + `Shift` + `+` _(Zoom In)_<br>
17822
- * `Ctrl` + `NumPad+` _(Zoom In)_<br>
17823
- * `Ctrl` + `-` _(Zoom Out)_<br>
17824
- * `Ctrl` + `Shift` + `-` _(Zoom Out)_<br>
17825
- * `Ctrl` + `NumPad-` _(Zoom Out)_<br>
17826
- * `Ctrl` + `Scroll` _(Zoom In & Out)_<br>
17827
- * `Ctrl` + `0` _(Restore to 100%)_
17828
- *
17829
- * @property {object} [alphaMask] - _Experimental._ _Updatable._
17830
- * <br>
17831
- * alphaMask turns anything of matching RGB value transparent.
17832
- * <br>
17833
- * Caveats:
17834
- * * Runtime flags --disable-gpu and --allow-unsafe-compositing are required. Note: Unclear behavior on remote Desktop support
17835
- * * User cannot click-through transparent regions
17836
- * * Not supported on Mac
17837
- * * Windows Aero must be enabled
17838
- * * Won't make visual sense on Pixel-pushed environments such as Citrix
17839
- * * Not supported on rounded corner windows
17840
- * @property {number} [alphaMask.red=-1] 0-255
17841
- * @property {number} [alphaMask.green=-1] 0-255
17842
- * @property {number} [alphaMask.blue=-1] 0-255
17843
- *
17844
- * @property {boolean} [alwaysOnTop=false] - _Updatable._
17845
- * A flag to always position the window at the top of the window stack.
17846
- *
17847
- * @property {object} [api]
17848
- * Configurations for API injection.
17849
- *
17850
- * @property {object} [api.iframe] Configure if the the API should be injected into iframes based on domain.
17851
- *
17852
- * @property {boolean} [api.iframe.crossOriginInjection=false] Controls if the `fin` API object is present for cross origin iframes.
17853
- * @property {boolean} [api.iframe.sameOriginInjection=true] Controls if the `fin` API object is present for same origin iframes.
17854
- *
17855
- * @property {string} [applicationIcon = ""] - _Deprecated_ - use `icon` instead.
17856
- *
17857
- * @property {number} [aspectRatio=0] - _Updatable._
17858
- * The aspect ratio of width to height to enforce for the window. If this value is equal to or less than zero,
17859
- * an aspect ratio will not be enforced.
17860
- *
17861
- * @property {string} [autoplayPolicy="no-user-gesture-required"]
17862
- * Autoplay policy to apply to content in the window, can be
17863
- * `no-user-gesture-required`, `user-gesture-required`,
17864
- * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
17865
- *
17866
- * @property {boolean} [autoShow=true]
17867
- * A flag to automatically show the window when it is created.
17868
- *
17869
- * @property {string} [backgroundColor="#FFF"]
17870
- * The window’s _backfill_ color as a hexadecimal value. Not to be confused with the content background color
17871
- * (`document.body.style.backgroundColor`),
17872
- * this color briefly fills a window’s (a) content area before its content is loaded as well as (b) newly exposed
17873
- * areas when growing a window. Setting
17874
- * this value to the anticipated content background color can help improve user experience.
17875
- * Default is white.
17876
- *
17877
- * @property {object} [contentCreation]
17878
- * Apply rules that determine how user interaction (`window.open` and links) creates content.
17879
- * @property {ContentCreationRule[]} [contentCreation.rules = []] List of content creation rules.
17880
- *
17881
- * @property {object} [contentNavigation]
17882
- * Restrict navigation to URLs that match an allowed pattern.
17883
- * In the lack of an allowlist, navigation to URLs that match a denied pattern would be prohibited.
17884
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17885
- * @property {string[]} [contentNavigation.allowlist=[]] List of allowed URLs.
17886
- * @property {string[]} [contentNavigation.denylist=[]] List of denied URLs.
17887
- *
17888
- * @property {object} [contentRedirect]
17889
- * Restrict redirects to URLs that match an allowed pattern.
17890
- * In the lack of an allowlist, redirects to URLs that match a denied pattern would be prohibited.
17891
- * See [here](https://developer.chrome.com/extensions/match_patterns) for more details.
17892
- * @property {string[]} [contentRedirect.allowlist=[]] List of allowed URLs.
17893
- * @property {string[]} [contentRedirect.denylist=[]] List of denied URLs.
17894
- *
17895
- * @property {boolean} [contextMenu=true] - _Updatable._
17896
- * A flag to show the context menu when right-clicking on a window.
17897
- * Gives access to the devtools for the window.
17898
- *
17899
- * @property {object} [contextMenuSettings] - _Updatable._
17900
- * Deprecated - superseded by {@link contextMenuOptions}, which offers a larger feature-set and cleaner syntax.
17901
- * Configure the context menu when right-clicking on a window.
17902
- * @property {boolean} [contextMenuSettings.enable=true] Should the context menu display on right click.
17903
- * @property {boolean} [contextMenuSettings.devtools=true] Should the context menu contain a button for opening devtools.
17904
- * @property {boolean} [contextMenuSettings.reload=true] Should the context menu contain a button for reloading the page.
17905
- *
17906
- * @property {object} [contextMenuOptions] - _Updatable._
17907
- * Configure the context menu when right-clicking on a window. Supported menu items:
17908
- * 'separator'
17909
- * 'cut'
17910
- * 'copy'
17911
- * 'paste'
17912
- * 'spellCheck'
17913
- * 'inspect'
17914
- * 'reload'
17915
- * 'navigateForward'
17916
- * 'navigateBack'
17917
- * 'print'
17918
- * @property {boolean} [contextMenuOptions.enabled = true] Should the context menu display on right click.
17919
- * @property {string[]} [contextMenuSettings.template=[]] List of context menu items to display on right-click.
17920
- *
17921
- * @property {object} [cornerRounding] - _Updatable._
17922
- * Defines and applies rounded corners for a frameless window. **NOTE:** On macOS corner is not ellipse but circle rounded by the
17923
- * average of _height_ and _width_.
17924
- * @property {number} [cornerRounding.height=0] The height in pixels.
17925
- * @property {number} [cornerRounding.width=0] The width in pixels.
17926
- *
17927
- * @property {any} [customContext=""] - _Updatable. Inheritable._
17928
- * A field that the user can use to attach serializable data that will be saved when {@link Platform#getSnapshot Platform.getSnapshot}
17929
- * is called. If a window in a Platform is trying to update or retrieve its own context, it can use the
17930
- * {@link Platform#setWindowContext Platform.setWindowContext} and {@link Platform#getWindowContext Platform.getWindowContext} calls.
17931
- * _When omitted, _inherits_ from the parent application._
17932
- * As opposed to customData, this is meant for frequent updates and sharing with other contexts. [Example]{@tutorial customContext}
17933
- *
17934
- * @property {any} [customData=""] - _Updatable. Inheritable._
17935
- * A field that the user can attach serializable data to be ferried around with the window options.
17936
- * _When omitted, _inherits_ from the parent application._
17937
- *
17938
- * @property {object[]} [customRequestHeaders]
17939
- * Defines list of custom headers for requests sent by the window.
17940
- * @property {string[]} [customRequestHeaders.urlPatterns=[]] The URL patterns for which the headers will be applied
17941
- * @property {object[]} [customRequestHeaders.headers=[]] Objects representing headers and their values,
17942
- * where the object key is the name of header and value at key is the value of the header
17943
- *
17944
- * @property {boolean} [closeOnLastViewRemoved=true] - _Experimental._ _Updatable._
17945
- * Toggling off would keep the Window alive even if all its Views were closed.
17946
- * This is meant for advanced users and should be used with caution.
17947
- * Limitations - Once a Layout has been emptied out of all views it's not usable anymore, and certain API calls will fail.
17948
- * Use `layout.replace` to create a fresh Layout instance in case you want to populate it with Views again.
17949
- * ** note ** - This option is ignored in non-Platforms apps.
17950
- *
17951
- * @property {boolean} [defaultCentered=false]
17952
- * Centers the window in the primary monitor. This option overrides `defaultLeft` and `defaultTop`. When `saveWindowState` is `true`,
17953
- * this value will be ignored for subsequent launches in favor of the cached value. **NOTE:** On macOS _defaultCenter_ is
17954
- * somewhat above center vertically.
17955
- *
17956
- * @property {number} [defaultHeight=500]
17957
- * The default height of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent launches
17958
- * in favor of the cached value.
17959
- *
17960
- * @property {number} [defaultLeft=100]
17961
- * The default left position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17962
- * launches in favor of the cached value.
17963
- *
17964
- * @property {number} [defaultTop=100]
17965
- * The default top position of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17966
- * launches in favor of the cached value.
17967
- *
17968
- * @property {number} [defaultWidth=800]
17969
- * The default width of the window. When `saveWindowState` is `true`, this value will be ignored for subsequent
17970
- * launches in favor of the cached value.
17971
- *
17972
- * @property {boolean} [includeInSnapshots=true] - _Updatable._
17973
- * When true, the window will be be included in snapshots returned by Platform.getSnapshot(). Turning this off may be desirable when dealing with
17974
- * inherently temporary windows whose state shouldn't be preserved, such as modals, menus, or popups.
17975
- *
17976
- * @property {boolean} [frame=true] - _Updatable._
17977
- * A flag to show the frame.
17978
- *
17979
- * @hidden-property {boolean} [hideOnClose=false] - A flag to allow a window to be hidden when the close button is clicked.
17980
- *
17981
- * @property {object[]} [hotkeys=[]] - _Updatable._
17982
- * Defines the list of hotkeys that will be emitted as a `hotkey` event on the window. For usage example see [example]{@tutorial hotkeys}.
17983
- * Within Platform, OpenFin also implements a set of pre-defined actions called
17984
- * [keyboard commands]{@link https://developers.openfin.co/docs/platform-api#section-5-3-using-keyboard-commands}
17985
- * that can be assigned to a specific hotkey in the platform manifest.
17986
- * @property {string} hotkeys.keys The key combination of the hotkey, i.e. "Ctrl+T"
17987
- * @property {boolean} [hotkeys.preventDefault=false] Whether or not to prevent default key handling before emitting the event
17988
- *
17989
- * @property {string} [icon] - _Updatable. Inheritable._
17990
- * A URL for the icon to be shown in the window title bar and the taskbar.
17991
- * When omitted, inherits from the parent application._
17992
- * note: Window OS caches taskbar icons, therefore an icon change might only be visible after the cache is removed or the uuid is changed.
17993
- *
17994
- * @property {number} [maxHeight=-1] - _Updatable._
17995
- * The maximum height of a window. Will default to the OS defined value if set to -1.
17996
- *
17997
- * @property {boolean} [maximizable=true] - _Updatable._
17998
- * A flag that lets the window be maximized.
17999
- *
18000
- * @property {number} [maxWidth=-1] - _Updatable._
18001
- * The maximum width of a window. Will default to the OS defined value if set to -1.
18002
- *
18003
- * @property {number} [minHeight=0] - _Updatable._
18004
- * The minimum height of a window.
18005
- *
18006
- * @property {boolean} [minimizable=true] - _Updatable._
18007
- * A flag that lets the window be minimized.
18008
- *
18009
- * @property {number} [minWidth=0] - _Updatable._
18010
- * The minimum width of a window.
18011
- *
18012
- * @property {Identity} [modalParentIdentity]
18013
- * Parent identity of a modal window. It will create a modal child window when this option is set.
18014
- *
18015
- * @property {string} name
18016
- * The name of the window.
18017
- *
18018
- * @property {number} [opacity=1.0] - _Updatable._
18019
- * A flag that specifies how transparent the window will be.
18020
- * Changing opacity doesn't work on Windows 7 without Aero so setting this value will have no effect there.
18021
- * This value is clamped between `0.0` and `1.0`.
18022
- * * In software composition mode, the runtime flag --allow-unsafe-compositing is required.
18023
- *
18024
- * @property {preloadScript[]} [preloadScripts] - _Inheritable_
18025
- * A list of scripts that are eval'ed before other scripts in the page. When omitted, _inherits_
18026
- * from the parent application.
18027
- *
18028
- * @property {string} [processAffinity]
18029
- * A string to attempt to group renderers together. Will only be used if pages are on the same origin.
18030
- *
18031
- * @property {boolean} [resizable=true] - _Updatable._
18032
- * A flag to allow the user to resize the window.
18033
- *
18034
- * @property {object} [resizeRegion] - _Updatable._
18035
- * Defines a region in pixels that will respond to user mouse interaction for resizing a frameless window.
18036
- * @property {number} [resizeRegion.bottomRightCorner=9]
18037
- * The size in pixels of an additional square resizable region located at the bottom right corner of a frameless window.
18038
- * @property {number} [resizeRegion.size=7]
18039
- * The size in pixels.
18040
- * @property {object} [resizeRegion.sides={top:true,right:true,bottom:true,left:true}]
18041
- * Sides that a window can be resized from.
18042
- *
18043
- * @property {boolean} [saveWindowState=true]
18044
- * A flag to cache the location of the window.
18045
- * ** note ** - This option is ignored in Platforms as it would cause inconsistent {@link Platform#applySnapshot applySnapshot} behavior.
18046
- *
18047
- * @property {boolean} [ignoreSavedWindowState]
18048
- * A flag to ignore previously cached state of the window. It defaults the opposite value of `saveWindowState` to maintain backwards compatibility.
18049
- *
18050
- * @property {boolean} [shadow=false]
18051
- * A flag to display a shadow on frameless windows.
18052
- * `shadow` and `cornerRounding` are mutually exclusive.
18053
- * On Windows 7, Aero theme is required.
18054
- *
18055
- * @property {boolean} [showBackgroundImages=false] - _Updatable._
18056
- * Platforms Only. If true, will show background images in the layout when the Views are hidden.
18057
- * This occurs when the window is resizing or a tab is being dragged within the layout.
18058
- *
18059
- * @property {boolean} [showTaskbarIcon=true] - _Updatable._ _Windows_.
18060
- * A flag to show the window's icon in the taskbar.
18061
- *
18062
- * @property {boolean} [smallWindow=false]
18063
- * A flag to specify a frameless window that can be be created and resized to less than 41x36 px (width x height).
18064
- * _Note: Caveats of small windows are no Aero Snap and drag to/from maximize._
18065
- * _Windows 10: Requires `maximizable` to be false. Resizing with the mouse is only possible down to 38x39 px._
18066
- *
18067
- * @property {boolean} [spellCheck=false]
18068
- * Enable spell check in input text fields for the window.
18069
- *
18070
- * @property {string} [state="normal"]
18071
- * The visible state of the window on creation.
18072
- * One of:
18073
- * * `"maximized"`
18074
- * * `"minimized"`
18075
- * * `"normal"`
18076
- *
18077
- * @property {string} [taskbarIcon=string] - Deprecated - use `icon` instead._Windows_.
18078
- *
18079
- * @property {string} [taskbarIconGroup=<application uuid>] - _Windows_.
18080
- * Specify a taskbar group for the window.
18081
- * _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
18082
- *
18083
- * @property {string} [url="about:blank"]
18084
- * The URL of the window.
18085
- *
18086
- * @property {string} [uuid=<application uuid>]
18087
- * The `uuid` of the application, unique within the set of all `Application`s running in OpenFin Runtime.
18088
- * If omitted, defaults to the `uuid` of the application spawning the window.
18089
- * If given, must match the `uuid` of the application spawning the window.
18090
- * In other words, the application's `uuid` is the only acceptable value, but is the default, so there's
18091
- * really no need to provide it.
18092
- *
18093
- * @property {boolean} [waitForPageLoad=false]
18094
- * When set to `true`, the window will not appear until the `window` object's `load` event fires.
18095
- * When set to `false`, the window will appear immediately without waiting for content to be loaded.
18096
- *
18097
- * @property {ViewVisibility} [viewVisibility]
18098
- * _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18099
- */
18100
- /**
18101
- * @PORTED
18102
- * @typedef {Object} ViewVisibility@typedef {Object} ViewVisibility _Platform Windows Only_. Controls behavior for showing views when they are being resized by the user.
18103
- * @property {ShowViewsOnWindowResize} [showViewsOnWindowResize] Enables views to be shown when a Platform Window is being resized by the user.
18104
- * @property {ShowViewsOnSplitterDrag} [showViewsOnSplitterDrag] Allows views to be shown when they are resized by the user dragging the splitter between layout stacks.
18105
- * @property {ShowViewsOnTabDrag} [showViewsOnTabDrag] _Supported on Windows Operating Systems only_. Allows views to be shown when the user is dragging a tab around a layout.
18106
- */
18107
- /**
18108
- * @PORTED
18109
- * @typedef {Object} ShowViewsOnWindowResize@typedef {Object} ShowViewsOnWindowResize _Platform Windows Only_. Enables views to be shown when a Platform Window is being resized by the user.
18110
- * @property {boolean} [enabled=false] Enables or disables showing Views when a Platform Window is being resized.
18111
- * @property {number} [paintIntervalMs=0] Number of miliseconds to wait between view repaints.
18112
- */
18113
- /**
18114
- * @REMOVED
18115
- * @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.
18116
- * @property {boolean} [enabled=false] Enables or disables showing views when the layout splitter is being dragged.
18117
- */
18118
- /**
18119
- * @REMOVED
18120
- * @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.
18121
- * @property {boolean} [enabled=false] Enables or disables showing views when a tab is being dragged.
18122
- */
18123
- /**
18124
- * @PORTED
18125
- * @typedef {object} CapturePageOptions@typedef {object} CapturePageOptions
18126
- * @property { Area } [area] The area of the window to be captured.
18127
- * @property { string } [format='png'] The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
18128
- * @property { number } [quality=100] Number representing quality of JPEG image only. Between 0 - 100.
18129
- */
18130
- /**
18131
- * @PORTED
18132
- * @typedef { object } Area@typedef { object } Area
18133
- * @property { number } height Area's height
18134
- * @property { number } width Area's width
18135
- * @property { number } x X coordinate of area's starting point
18136
- * @property { number } y Y coordinate of area's starting point
18137
- */
18138
- /**
18139
- * @PORTED
18140
- * @typedef {object} FindInPageOptions@typedef {object} FindInPageOptions
18141
- * @property {boolean} [forward=true] Whether to search forward or backward.
18142
- * @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.
18143
- * @property {boolean} [matchCase=false] Whether search should be case-sensitive.
18144
- * @property {boolean} [wordStart=false] Whether to look only at the start of words.
18145
- * @property {boolean} [medialCapitalAsWordStart=false]
18146
- * 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>
18147
- * lowercase or non-letter. Accepts several other intra-word matches.
18148
- */
18149
- /**
18150
- * @REMOVED
18151
- * @typedef {object} Transition@typedef {object} Transition
18152
- * @property {Opacity} opacity - The Opacity transition
18153
- * @property {Position} position - The Position transition
18154
- * @property {Size} size - The Size transition
18155
- */
18156
- /**
18157
- * @PORTED
18158
- * @typedef {object} TransitionOptions@typedef {object} TransitionOptions
18159
- * @property {boolean} interrupt - This option interrupts the current animation. When false it pushes
18160
- this animation onto the end of the animation queue.
18161
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18162
- */
18163
- /**
18164
- * @PORTED
18165
- * @typedef {object} Size@typedef {object} Size
18166
- * @property {number} duration - The total time in milliseconds this transition should take.
18167
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18168
- * @property {number} width - Optional if height is present. Defaults to the window's current width.
18169
- * @property {number} height - Optional if width is present. Defaults to the window's current height.
18170
- */
18171
- /**
18172
- * @PORTED
18173
- * @typedef {object} Position@typedef {object} Position
18174
- * @property {number} duration - The total time in milliseconds this transition should take.
18175
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18176
- * @property {number} left - Defaults to the window's current left position in virtual screen coordinates.
18177
- * @property {number} top - Defaults to the window's current top position in virtual screen coordinates.
18178
- */
18179
- /**
18180
- * @PORTED
18181
- * @typedef {object} Opacity@typedef {object} Opacity
18182
- * @property {number} duration - The total time in milliseconds this transition should take.
18183
- * @property {boolean} relative - Treat 'opacity' as absolute or as a delta. Defaults to false.
18184
- * @property {number} opacity - This value is clamped from 0.0 to 1.0.
18185
- */
18186
- /**
18187
- * @REMOVED
18188
- * Bounds is a interface that has the properties of height,
18189
- * width, left, top which are all numbers
18190
- * @typedef { object } Bounds@typedef { object } Bounds
18191
- * @property { number } height Get the application height bound
18192
- * @property { number } width Get the application width bound
18193
- * @property { number } top Get the application top bound
18194
- * @property { number } left Get the application left bound
18195
- * @property { number } right Get the application right bound
18196
- * @property { number } bottom Get the application bottom bound
18197
- */
18198
17117
  /**
18199
17118
  * A basic window that wraps a native HTML window. Provides more fine-grained
18200
17119
  * control over the window state such as the ability to minimize, maximize, restore, etc.
@@ -18980,10 +17899,9 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
18980
17899
  show(force?: boolean): Promise<void>;
18981
17900
  /**
18982
17901
  * Shows the window if it is hidden at the specified location.
18983
- * If the toggle parameter is set to true, the window will
18984
- * alternate between showing and hiding.
18985
- * @param left The left position of the window
18986
- * @param top The right position of the window
17902
+ *
17903
+ * @param left The left position of the window in pixels
17904
+ * @param top The top position of the window in pixels
18987
17905
  * @param force Show will be prevented from closing when force is false and
18988
17906
  * ‘show-requested’ has been subscribed to for application’s main window
18989
17907
  *
@@ -19045,28 +17963,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19045
17963
  * ```
19046
17964
  */
19047
17965
  authenticate(userName: string, password: string): Promise<void>;
19048
- /**
19049
- * @typedef {object} ShowPopupMenuOptions@typedef {object} ShowPopupMenuOptions
19050
- * @property {Array<MenuItemTemplate>} template - An array describing the menu to show.
19051
- * @property {number} [x] - The window x coordinate where to show the menu. Defaults to mouse position. If using must also use `y`.
19052
- * @property {number} [y] - The window y coordinate where to show the menu. Defaults to mouse position. If using must also use `x`
19053
- */
19054
- /**
19055
- * @typedef {object} MenuItemTemplate@typedef {object} MenuItemTemplate
19056
- * @property {*} data - Data to be returned if the user selects the element. Must be serializable. Large objects can have a performance impact.
19057
- * @property {'normal' | 'separator' | 'submenu' | 'checkbox'} [type] - Defaults to 'normal' unless a 'submenu' key exists
19058
- * @property {string} [label] - The text to show on the menu item. Should be left undefined for `type: 'separator'`
19059
- * @property {boolean} [enabled] - If false, the menu item will be greyed out and unclickable.
19060
- * @property {boolean} [visible] - If false, the menu item will be entirely hidden.
19061
- * @property {boolean} [checked] - Should only be specified for `checkbox` type menu items.
19062
- * @property {string} [icon] - Image Data URI with image dimensions inferred from the encoded string
19063
- * @property {Array<MenuItemTemplate>} [submenu] Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted.
19064
- */
19065
- /**
19066
- * @typedef {object} MenuResult@typedef {object} MenuResult
19067
- * @property {'clicked' | 'closed'} result - Whether the user clicked on a menu item or the menu was closed (user clicked elsewhere).
19068
- * @property {* | undefined} [data] - The data property of the menu item clicked by the user. Only defined if result was `clicked`.
19069
- */
19070
17966
  /**
19071
17967
  * Shows a menu on the window.
19072
17968
  *
@@ -19163,577 +18059,552 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
19163
18059
  */
19164
18060
  closePopupMenu(): Promise<void>;
19165
18061
  /**
19166
- * @PORTED
19167
- * @typedef {object} PopupOptions@typedef {object} PopupOptions
19168
- * @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.
19169
- * @property {string} [url] - Navigates to this `url` if showing an existing window as a popup, otherwise the newly created window will load this `url`.
19170
- * @property {Window~options} [initialOptions] - Window creation options when using `showPopupWindow` to create a new window.
19171
- * @property {Window~options} [additionalOptions] - Updatable window options applied to new and existing windows when shown as popups.
19172
- * @property {function} [onPopupResult] - Executed when this window's popup calls `dispatchPopupResult`. Note: if this is defined, `showPopupWindow` will not return a `PopupResult`.
19173
- * @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.
19174
- * @property {number} [height] - Height of the popup window (takes priority over `intialOptions` size properties).
19175
- * @property {number} [width] - Width of the popup window (takes priority over `intialOptions` size properties).
19176
- * @property {number} [x] - Left position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19177
- * @property {number} [y] - Top position where the popup window will be shown (relative to the window calling `showPopupWindow`).
19178
- * @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.
19179
- * @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`.
19180
- * @property {boolean} [focus] - Determines if the popup window should or should not be focused when it is shown.
19181
- * @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.
19182
- */
19183
- /**
19184
- * @PORTED
19185
- * @typedef {object} PopupResult@typedef {object} PopupResult
19186
- * @property {Identity} identity - `name` and `uuid` of the popup window that called dispatched this result.
19187
- * @property {'clicked' | 'dismissed'} result - Result of the user interaction with the popup window.
19188
- * @property {* | undefined} [data] - Data passed to `dispatchPopupResult`.
19189
- */
19190
- /**
19191
- * Dispatch a result to the caller of `showPopupWindow`.
19192
- *
19193
- * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
19194
- * @param data Serializable data to send to the caller window.
19195
- *
19196
- * @example
19197
- * ```js
19198
- * await fin.me.dispatchPopupResult({
19199
- * foo: 'bar'
19200
- * });
19201
- * ```
19202
- */
19203
- dispatchPopupResult(data: any): Promise<void>;
19204
- /**
19205
- * Prints the contents of the window.
19206
- *
19207
- * @param options Configuration for the print task.
19208
- * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
19209
- * and the default settings for printing.
19210
- *
19211
- * Use the CSS style `page-break-before: always;` to force print to a new page.
19212
- *
19213
- * @example
19214
- * ```js
19215
- * const win = fin.Window.getCurrentSync();
19216
- *
19217
- * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
19218
- * console.log('print call has been sent to the system');
19219
- * });
19220
- * ```
19221
- *
19222
- * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
19223
- * use the `content` option:
19224
- *
19225
- * ```js
19226
- * const win = fin.Window.getCurrentSync();
19227
- *
19228
- * // Print embedded views
19229
- * win.print({ content: 'views' });
19230
- *
19231
- * // Print screenshot of current window
19232
- * win.print({ content: 'screenshot' })
19233
- * ```
19234
- *
19235
- * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
19236
- * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
19237
- * page - be aware that this page will *not* include the embedded views - it will only include the contents of
19238
- * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
19239
- *
19240
- * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
19241
- * printing `contents: views`. This includes views that are obscured behind other active UI elements.
19242
- *
19243
- * To print the views embedded in their page context, set `content` to `screenshot`.
19244
- */
19245
- print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
19246
- }
19247
-
19248
- /**
19249
- * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
19250
- * @interface
19251
- */
19252
- declare type WindowAlertRequestedEvent = BaseEvent_3 & {
19253
- type: 'window-alert-requested';
19254
- };
19255
-
19256
- /**
19257
- * Returned from getBounds call. bottom and right are never used for setting.
19258
- * @interface
19259
- */
19260
- declare type WindowBounds = Bounds & {
19261
- bottom: number;
19262
- right: number;
19263
- };
19264
-
19265
- /**
19266
- * @deprecated Renamed to {@link ClosedEvent}.
19267
- */
19268
- declare type WindowClosedEvent = ClosedEvent_2;
19269
-
19270
- /**
19271
- * @deprecated Renamed to {@link CloseRequestedEvent}.
19272
- */
19273
- declare type WindowCloseRequestedEvent = CloseRequestedEvent;
19274
-
19275
- /**
19276
- * @deprecated Renamed to {@link ClosingEvent}.
19277
- */
19278
- declare type WindowClosingEvent = ClosingEvent;
19279
-
19280
- /**
19281
- * A rule prescribing content creation in a {@link OpenFin.Window}.
19282
- *
19283
- * @interface
19284
- */
19285
- declare type WindowContentCreationRule = BaseContentCreationRule & {
19286
- /**
19287
- * Behavior to use when opening matched content.
19288
- */
19289
- behavior: 'window';
19290
- /**
19291
- * Options for newly-created window.
19292
- */
19293
- options?: Partial<WindowOptions>;
19294
- };
19295
-
19296
- /**
19297
- * Generated when a child window is created.
19298
- * @interface
19299
- */
19300
- declare type WindowCreatedEvent = BaseEvent_3 & {
19301
- type: 'window-created';
19302
- };
19303
-
19304
- /**
19305
- * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
19306
- *
19307
- * Note that `name` is the only required property — albeit the `url` property is usually provided as well
19308
- * (defaults to `"about:blank"` when omitted).
19309
- * @interface
19310
- */
19311
- declare type WindowCreationOptions = Partial<WindowOptions> & {
19312
- name: string;
19313
- };
19314
-
19315
- declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
19316
-
19317
- /**
19318
- * @interface
19319
- */
19320
- declare type WindowDetail = {
19321
- /**
19322
- * The bottom-most coordinate of the window.
19323
- */
19324
- bottom: number;
19325
- /**
19326
- * The height of the window.
19327
- */
19328
- height: number;
19329
- isShowing: boolean;
19330
- /**
19331
- * The left-most coordinate of the window.
19332
- */
19333
- left: number;
19334
- /**
19335
- * The name of the window.
19336
- */
19337
- name: string;
19338
- /**
19339
- * The right-most coordinate of the window.
19340
- */
19341
- right: number;
19342
- state: string;
19343
- /**
19344
- * The top-most coordinate of the window.
19345
- */
19346
- top: number;
19347
- /**
19348
- * The width of the window.
19349
- */
19350
- width: number;
19351
- };
19352
-
19353
- /**
19354
- * Generated when a child window ends loading.
19355
- * @interface
19356
- */
19357
- declare type WindowEndLoadEvent = BaseEvent_3 & {
19358
- type: 'window-end-load';
19359
- };
19360
-
19361
- /**
19362
- * @deprecated, Renamed to {@link Event}.
19363
- */
19364
- declare type WindowEvent = Event_6;
19365
-
19366
- declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
19367
-
19368
- declare namespace WindowEvents {
19369
- export {
19370
- BaseEvent_5 as BaseEvent,
19371
- BaseWindowEvent,
19372
- ViewAttachedEvent,
19373
- ViewDetachedEvent,
19374
- WindowViewEvent,
19375
- AlertRequestedEvent,
19376
- AuthRequestedEvent,
19377
- EndLoadEvent,
19378
- WillRedirectEvent,
19379
- ReloadedEvent,
19380
- OptionsChangedEvent,
19381
- WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
19382
- ExternalProcessExitedEvent,
19383
- ExternalProcessStartedEvent,
19384
- HiddenEvent_2 as HiddenEvent,
19385
- WindowHiddenEvent,
19386
- PreloadScriptInfoRunning,
19387
- PreloadScriptInfo,
19388
- PreloadScriptsStateChangeEvent,
19389
- UserBoundsChangeEvent,
19390
- BoundsChangeEvent,
19391
- WillMoveOrResizeEvent,
19392
- PerformanceReportEvent,
19393
- InputEvent_2 as InputEvent,
19394
- LayoutInitializedEvent,
19395
- LayoutReadyEvent,
19396
- BeginUserBoundsChangingEvent,
19397
- BoundsChangedEvent,
19398
- BoundsChangingEvent,
19399
- CloseRequestedEvent,
19400
- WindowCloseRequestedEvent,
19401
- ContextChangedEvent,
19402
- ClosedEvent_2 as ClosedEvent,
19403
- WindowClosedEvent,
19404
- ClosingEvent,
19405
- WindowClosingEvent,
19406
- DisabledMovementBoundsChangedEvent,
19407
- DisabledMovementBoundsChangingEvent,
19408
- EmbeddedEvent,
19409
- EndUserBoundsChangingEvent,
19410
- HotkeyEvent_2 as HotkeyEvent,
19411
- WindowHotkeyEvent,
19412
- InitializedEvent_2 as InitializedEvent,
19413
- WindowInitializedEvent,
19414
- MaximizedEvent,
19415
- MinimizedEvent,
19416
- PreloadScriptsStateChangedEvent,
19417
- PreloadScriptsStateChangingEvent,
19418
- RestoredEvent,
19419
- WindowRestoredEvent,
19420
- ShowRequestedEvent,
19421
- WindowShowRequestedEvent,
19422
- ShownEvent_2 as ShownEvent,
19423
- WindowShownEvent,
19424
- UserMovementEnabledEvent,
19425
- UserMovementDisabledEvent,
19426
- WillMoveEvent,
19427
- WillResizeEvent,
19428
- NonPropagatedWindowEvent,
19429
- ShowAllDownloadsEvent,
19430
- DownloadShelfVisibilityChangedEvent,
19431
- WindowSourcedEvent,
19432
- WillPropagateWindowEvent,
19433
- Event_6 as Event,
19434
- WindowEvent,
19435
- EventType_2 as EventType,
19436
- WindowEventType,
19437
- PropagatedEvent_3 as PropagatedEvent,
19438
- PropagatedWindowEvent,
19439
- PropagatedWindowEventType,
19440
- Payload_3 as Payload,
19441
- ByType_2 as ByType
19442
- }
19443
- }
19444
-
19445
- /**
19446
- * @deprecated Renamed to {@link EventType}.
19447
- */
19448
- declare type WindowEventType = WindowEvent['type'];
19449
-
19450
- /**
19451
- * @deprecated Renamed to {@link HiddenEvent}.
19452
- */
19453
- declare type WindowHiddenEvent = HiddenEvent_2;
19454
-
19455
- /**
19456
- * @deprecated Renamed to {@link HotkeyEvent}.
19457
- */
19458
- declare type WindowHotkeyEvent = HotkeyEvent_2;
19459
-
19460
- /**
19461
- * @interface
19462
- */
19463
- declare type WindowInfo = {
19464
- canNavigateBack: boolean;
19465
- canNavigateForward: boolean;
19466
- preloadScripts: Array<any>;
19467
- title: string;
19468
- url: string;
19469
- };
19470
-
19471
- /**
19472
- * @deprecated Renamed to {@link InitializedEvent}.
19473
- */
19474
- declare type WindowInitializedEvent = InitializedEvent_2;
19475
-
19476
- /**
19477
- * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
19478
- */
19479
- declare class _WindowModule extends Base {
19480
- /**
19481
- * Asynchronously returns a Window object that represents an existing window.
19482
- *
19483
- * @example
19484
- * ```js
19485
- * async function createWin() {
19486
- * const app = await fin.Application.start({
19487
- * name: 'myApp',
19488
- * uuid: 'app-1',
19489
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
19490
- * autoShow: true
19491
- * });
19492
- * return await app.getWindow();
19493
- * }
19494
- * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
19495
- * .then(win => console.log('wrapped window'))
19496
- * .catch(err => console.log(err));
19497
- * ```
19498
- */
19499
- wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
19500
- /**
19501
- * Synchronously returns a Window object that represents an existing window.
19502
- *
19503
- * @example
19504
- * ```js
19505
- * async function createWin() {
19506
- * const app = await fin.Application.start({
19507
- * name: 'myApp',
19508
- * uuid: 'app-1',
19509
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
19510
- * autoShow: true
19511
- * });
19512
- * return await app.getWindow();
19513
- * }
19514
- * await createWin();
19515
- * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
19516
- * ```
19517
- */
19518
- wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
19519
- /**
19520
- * Creates a new Window.
19521
- * @param options - Window creation options
19522
- *
19523
- * @example
19524
- * ```js
19525
- * async function createWindow() {
19526
- * const winOption = {
19527
- * name:'child',
19528
- * defaultWidth: 300,
19529
- * defaultHeight: 300,
19530
- * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
19531
- * frame: true,
19532
- * autoShow: true
19533
- * };
19534
- * return await fin.Window.create(winOption);
19535
- * }
19536
- *
19537
- * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
19538
- * ```
19539
- */
19540
- create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
19541
- /**
19542
- * Asynchronously returns a Window object that represents the current window
19543
- *
19544
- * @example
19545
- * ```js
19546
- * fin.Window.getCurrent()
19547
- * .then(wnd => console.log('current window'))
19548
- * .catch(err => console.log(err));
19549
- *
19550
- * ```
19551
- */
19552
- getCurrent(): Promise<OpenFin_2.Window>;
19553
- /**
19554
- * Synchronously returns a Window object that represents the current window
19555
- *
19556
- * @example
19557
- * ```js
19558
- * const wnd = fin.Window.getCurrentSync();
19559
- * const info = await wnd.getInfo();
19560
- * console.log(info);
19561
- *
19562
- * ```
19563
- */
19564
- getCurrentSync(): OpenFin_2.Window;
19565
- }
19566
-
19567
- /**
19568
- * Generated when a child window is not responding.
19569
- * @interface
19570
- */
19571
- declare type WindowNotRespondingEvent = BaseEvent_3 & {
19572
- type: 'window-not-responding';
19573
- };
19574
-
19575
- /**
19576
- * @interface
19577
- */
19578
- declare type WindowOptionDiff = {
19579
- [key in keyof WindowOptions]: {
19580
- oldVal: WindowOptions[key];
19581
- newVal: WindowOptions[key];
19582
- };
19583
- };
19584
-
19585
- /**
19586
- * @interface
19587
- */
19588
- declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
19589
-
19590
- declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
19591
-
19592
- /**
19593
- * @deprecated Renamed to {@link OptionsChangedEvent}.
19594
- */
19595
- declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
19596
-
19597
- declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
19598
-
19599
- /**
19600
- * Generated when a child window is responding.
19601
- * @interface
19602
- */
19603
- declare type WindowRespondingEvent = BaseEvent_3 & {
19604
- type: 'window-responding';
19605
- };
19606
-
19607
- /**
19608
- * @deprecated Renamed to {@link RestoredEvent}.
19609
- */
19610
- declare type WindowRestoredEvent = RestoredEvent;
19611
-
19612
- /**
19613
- * @deprecated Renamed to {@link ShownEvent}.
19614
- */
19615
- declare type WindowShownEvent = ShownEvent_2;
19616
-
19617
- /**
19618
- * @deprecated Renamed to {@link ShowRequestedEvent}.
19619
- */
19620
- declare type WindowShowRequestedEvent = ShowRequestedEvent;
19621
-
19622
- /**
19623
- * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
19624
- * from {@link OpenFin.ViewEvents}.
19625
- */
19626
- 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;
19627
-
19628
- /**
19629
- * Generated when a child window starts loading.
19630
- * @interface
19631
- */
19632
- declare type WindowStartLoadEvent = BaseEvent_3 & {
19633
- type: 'window-start-load';
19634
- };
19635
-
19636
- /**
19637
- * Visibility state of a window.
19638
- */
19639
- declare type WindowState = 'maximized' | 'minimized' | 'normal';
19640
-
19641
- /**
19642
- * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
19643
- * to the `Application` level, with the name pattern `window-view-eventname`.
19644
- */
19645
- declare type WindowViewEvent = {
19646
- viewIdentity: OpenFin_2.Identity;
19647
- } & (ViewAttachedEvent | ViewDetachedEvent);
19648
-
19649
- /**
19650
- * @interface
19651
- */
19652
- declare type WindowViewsPrintOptions = {
19653
- content: 'views';
19654
- includeSelf?: boolean;
19655
- };
19656
-
19657
- declare type Wire = EventEmitter & {
19658
- connect(messageReciever: MessageReceiver): Promise<any>;
19659
- connectSync(): any;
19660
- send(data: any): Promise<any>;
19661
- shutdown(): Promise<void>;
19662
- getPort(): string;
19663
- };
19664
-
19665
- declare type WireConstructor = {
19666
- new (onmessage: (data: any) => void): Wire;
19667
- };
19668
-
19669
- /* Excluded from this release type: WithId */
19670
-
19671
- declare interface WithInterop {
19672
- interop: InteropClient;
19673
- }
19674
-
19675
- /* Excluded from this release type: WithoutId */
19676
-
19677
- declare type WithPositioningOptions<T extends {} = {}> = T & {
19678
- positioningOptions?: OpenFin_2.PositioningOptions;
19679
- };
19680
-
19681
- /* Excluded from this release type: WorkspacePlatformOptions */
19682
-
19683
- /**
19684
- * A generic request to write any supported data to the clipboard.
19685
- * @interface
19686
- */
19687
- declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
19688
- /**
19689
- * Data to be written
19690
- */
19691
- data: {
19692
- text?: string;
19693
- html?: string;
19694
- rtf?: string;
19695
- } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
19696
- };
19697
-
19698
- /**
19699
- * @deprecated - instead use WriteAnyClipboardRequest
19700
- *
19701
- * A generic request to write any supported data to the clipboard.
19702
- *
19703
- * @interface
19704
- */
19705
- declare type WriteAnyRequestType = WriteAnyClipboardRequest;
19706
-
19707
- /**
19708
- * A request to write data to the clipboard.
19709
- * @interface
19710
- */
19711
- declare type WriteClipboardRequest = BaseClipboardRequest & {
19712
- /**
19713
- * Data to write to the clipboard.
19714
- */
19715
- data: string;
19716
- };
19717
-
19718
- /**
19719
- * @interface
19720
- */
19721
- declare type WriteImageClipboardRequest = BaseClipboardRequest & {
19722
- /**
19723
- * Can be either a base64 string, or a DataURL string. If using DataURL, the
19724
- * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
19725
- * Using other image/<format> DataURLs will throw an Error.
19726
- */
19727
- image: string;
19728
- };
19729
-
19730
- /**
19731
- * @deprecated - instead use OpenFin.WriteClipboardRequest
19732
- *
19733
- * A request to write data to the clipboard.
19734
- *
19735
- * @interface
19736
- */
19737
- declare type WriteRequestType = WriteClipboardRequest;
19738
-
19739
- export { }
18062
+ * Dispatch a result to the caller of `showPopupWindow`.
18063
+ *
18064
+ * @remarks If this window isn't currently being shown as a popup, this call will silently fail.
18065
+ * @param data Serializable data to send to the caller window.
18066
+ *
18067
+ * @example
18068
+ * ```js
18069
+ * await fin.me.dispatchPopupResult({
18070
+ * foo: 'bar'
18071
+ * });
18072
+ * ```
18073
+ */
18074
+ dispatchPopupResult(data: any): Promise<void>;
18075
+ /**
18076
+ * Prints the contents of the window.
18077
+ *
18078
+ * @param options Configuration for the print task.
18079
+ * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName is empty
18080
+ * and the default settings for printing.
18081
+ *
18082
+ * Use the CSS style `page-break-before: always;` to force print to a new page.
18083
+ *
18084
+ * @example
18085
+ * ```js
18086
+ * const win = fin.Window.getCurrentSync();
18087
+ *
18088
+ * win.print({ silent: false, deviceName: 'system-printer-name' }).then(() => {
18089
+ * console.log('print call has been sent to the system');
18090
+ * });
18091
+ * ```
18092
+ *
18093
+ * If a window has embedded views, those views will not print by default. To print a window's contents including embedded views,
18094
+ * use the `content` option:
18095
+ *
18096
+ * ```js
18097
+ * const win = fin.Window.getCurrentSync();
18098
+ *
18099
+ * // Print embedded views
18100
+ * win.print({ content: 'views' });
18101
+ *
18102
+ * // Print screenshot of current window
18103
+ * win.print({ content: 'screenshot' })
18104
+ * ```
18105
+ *
18106
+ * When `content` is set to `views`, the embedded views in the platform window will be concatenated and printed as
18107
+ * individual pages. If `includeSelf` is set to `true`, the platform window itself will be printed as the first
18108
+ * page - be aware that this page will *not* include the embedded views - it will only include the contents of
18109
+ * the platform window itself (e.g. tab stacks), with blank spaces where the view contents would be embedded.
18110
+ *
18111
+ * Due to a known issue, view contents that are not visible at the time `print` is called will not appear when
18112
+ * printing `contents: views`. This includes views that are obscured behind other active UI elements.
18113
+ *
18114
+ * To print the views embedded in their page context, set `content` to `screenshot`.
18115
+ */
18116
+ print(options?: OpenFin_2.WindowPrintOptions): Promise<void>;
18117
+ }
18118
+
18119
+ /**
18120
+ * Generated when an alert is fired and suppressed due to the customWindowAlert flag being true.
18121
+ * @interface
18122
+ */
18123
+ declare type WindowAlertRequestedEvent = BaseEvent_3 & {
18124
+ type: 'window-alert-requested';
18125
+ };
18126
+
18127
+ /**
18128
+ * Returned from getBounds call. bottom and right are never used for setting.
18129
+ * @interface
18130
+ */
18131
+ declare type WindowBounds = Bounds & {
18132
+ bottom: number;
18133
+ right: number;
18134
+ };
18135
+
18136
+ /**
18137
+ * @deprecated Renamed to {@link ClosedEvent}.
18138
+ */
18139
+ declare type WindowClosedEvent = ClosedEvent_2;
18140
+
18141
+ /**
18142
+ * @deprecated Renamed to {@link CloseRequestedEvent}.
18143
+ */
18144
+ declare type WindowCloseRequestedEvent = CloseRequestedEvent;
18145
+
18146
+ /**
18147
+ * @deprecated Renamed to {@link ClosingEvent}.
18148
+ */
18149
+ declare type WindowClosingEvent = ClosingEvent;
18150
+
18151
+ /**
18152
+ * A rule prescribing content creation in a {@link OpenFin.Window}.
18153
+ *
18154
+ * @interface
18155
+ */
18156
+ declare type WindowContentCreationRule = BaseContentCreationRule & {
18157
+ /**
18158
+ * Behavior to use when opening matched content.
18159
+ */
18160
+ behavior: 'window';
18161
+ /**
18162
+ * Options for newly-created window.
18163
+ */
18164
+ options?: Partial<WindowOptions>;
18165
+ };
18166
+
18167
+ /**
18168
+ * Generated when a child window is created.
18169
+ * @interface
18170
+ */
18171
+ declare type WindowCreatedEvent = BaseEvent_3 & {
18172
+ type: 'window-created';
18173
+ };
18174
+
18175
+ /**
18176
+ * Options required to create a new window with {@link Window._WindowModule.create Window.create}.
18177
+ *
18178
+ * Note that `name` is the only required property — albeit the `url` property is usually provided as well
18179
+ * (defaults to `"about:blank"` when omitted).
18180
+ * @interface
18181
+ */
18182
+ declare type WindowCreationOptions = Partial<WindowOptions> & {
18183
+ name: string;
18184
+ };
18185
+
18186
+ declare type WindowCreationReason = 'tearout' | 'create-view-without-target' | 'api-call' | 'app-creation' | 'restore' | 'apply-snapshot';
18187
+
18188
+ /**
18189
+ * @interface
18190
+ */
18191
+ declare type WindowDetail = {
18192
+ /**
18193
+ * The bottom-most coordinate of the window.
18194
+ */
18195
+ bottom: number;
18196
+ /**
18197
+ * The height of the window.
18198
+ */
18199
+ height: number;
18200
+ isShowing: boolean;
18201
+ /**
18202
+ * The left-most coordinate of the window.
18203
+ */
18204
+ left: number;
18205
+ /**
18206
+ * The name of the window.
18207
+ */
18208
+ name: string;
18209
+ /**
18210
+ * The right-most coordinate of the window.
18211
+ */
18212
+ right: number;
18213
+ state: string;
18214
+ /**
18215
+ * The top-most coordinate of the window.
18216
+ */
18217
+ top: number;
18218
+ /**
18219
+ * The width of the window.
18220
+ */
18221
+ width: number;
18222
+ };
18223
+
18224
+ /**
18225
+ * Generated when a child window ends loading.
18226
+ * @interface
18227
+ */
18228
+ declare type WindowEndLoadEvent = BaseEvent_3 & {
18229
+ type: 'window-end-load';
18230
+ };
18231
+
18232
+ /**
18233
+ * @deprecated, Renamed to {@link Event}.
18234
+ */
18235
+ declare type WindowEvent = Event_6;
18236
+
18237
+ declare type WindowEvent_2 = Events.WindowEvents.WindowEvent;
18238
+
18239
+ declare namespace WindowEvents {
18240
+ export {
18241
+ BaseEvent_5 as BaseEvent,
18242
+ BaseWindowEvent,
18243
+ ViewAttachedEvent,
18244
+ ViewDetachedEvent,
18245
+ WindowViewEvent,
18246
+ AlertRequestedEvent,
18247
+ AuthRequestedEvent,
18248
+ EndLoadEvent,
18249
+ WillRedirectEvent,
18250
+ ReloadedEvent,
18251
+ OptionsChangedEvent,
18252
+ WindowOptionsChangedEvent_2 as WindowOptionsChangedEvent,
18253
+ ExternalProcessExitedEvent,
18254
+ ExternalProcessStartedEvent,
18255
+ HiddenEvent_2 as HiddenEvent,
18256
+ WindowHiddenEvent,
18257
+ PreloadScriptInfoRunning,
18258
+ PreloadScriptInfo,
18259
+ PreloadScriptsStateChangeEvent,
18260
+ UserBoundsChangeEvent,
18261
+ BoundsChangeEvent,
18262
+ WillMoveOrResizeEvent,
18263
+ PerformanceReportEvent,
18264
+ InputEvent_2 as InputEvent,
18265
+ LayoutInitializedEvent,
18266
+ LayoutReadyEvent,
18267
+ BeginUserBoundsChangingEvent,
18268
+ BoundsChangedEvent,
18269
+ BoundsChangingEvent,
18270
+ CloseRequestedEvent,
18271
+ WindowCloseRequestedEvent,
18272
+ ContextChangedEvent,
18273
+ ClosedEvent_2 as ClosedEvent,
18274
+ WindowClosedEvent,
18275
+ ClosingEvent,
18276
+ WindowClosingEvent,
18277
+ DisabledMovementBoundsChangedEvent,
18278
+ DisabledMovementBoundsChangingEvent,
18279
+ EmbeddedEvent,
18280
+ EndUserBoundsChangingEvent,
18281
+ HotkeyEvent_2 as HotkeyEvent,
18282
+ WindowHotkeyEvent,
18283
+ InitializedEvent_2 as InitializedEvent,
18284
+ WindowInitializedEvent,
18285
+ MaximizedEvent,
18286
+ MinimizedEvent,
18287
+ PreloadScriptsStateChangedEvent,
18288
+ PreloadScriptsStateChangingEvent,
18289
+ RestoredEvent,
18290
+ WindowRestoredEvent,
18291
+ ShowRequestedEvent,
18292
+ WindowShowRequestedEvent,
18293
+ ShownEvent_2 as ShownEvent,
18294
+ WindowShownEvent,
18295
+ UserMovementEnabledEvent,
18296
+ UserMovementDisabledEvent,
18297
+ WillMoveEvent,
18298
+ WillResizeEvent,
18299
+ NonPropagatedWindowEvent,
18300
+ ShowAllDownloadsEvent,
18301
+ DownloadShelfVisibilityChangedEvent,
18302
+ WindowSourcedEvent,
18303
+ WillPropagateWindowEvent,
18304
+ Event_6 as Event,
18305
+ WindowEvent,
18306
+ EventType_2 as EventType,
18307
+ WindowEventType,
18308
+ PropagatedEvent_3 as PropagatedEvent,
18309
+ PropagatedWindowEvent,
18310
+ PropagatedWindowEventType,
18311
+ Payload_3 as Payload,
18312
+ ByType_2 as ByType
18313
+ }
18314
+ }
18315
+
18316
+ /**
18317
+ * @deprecated Renamed to {@link EventType}.
18318
+ */
18319
+ declare type WindowEventType = WindowEvent['type'];
18320
+
18321
+ /**
18322
+ * @deprecated Renamed to {@link HiddenEvent}.
18323
+ */
18324
+ declare type WindowHiddenEvent = HiddenEvent_2;
18325
+
18326
+ /**
18327
+ * @deprecated Renamed to {@link HotkeyEvent}.
18328
+ */
18329
+ declare type WindowHotkeyEvent = HotkeyEvent_2;
18330
+
18331
+ /**
18332
+ * @interface
18333
+ */
18334
+ declare type WindowInfo = {
18335
+ canNavigateBack: boolean;
18336
+ canNavigateForward: boolean;
18337
+ preloadScripts: Array<any>;
18338
+ title: string;
18339
+ url: string;
18340
+ };
18341
+
18342
+ /**
18343
+ * @deprecated Renamed to {@link InitializedEvent}.
18344
+ */
18345
+ declare type WindowInitializedEvent = InitializedEvent_2;
18346
+
18347
+ /**
18348
+ * Static namespace for OpenFin API methods that interact with the {@link _Window} class, available under `fin.Window`.
18349
+ */
18350
+ declare class _WindowModule extends Base {
18351
+ /**
18352
+ * Asynchronously returns a Window object that represents an existing window.
18353
+ *
18354
+ * @example
18355
+ * ```js
18356
+ * async function createWin() {
18357
+ * const app = await fin.Application.start({
18358
+ * name: 'myApp',
18359
+ * uuid: 'app-1',
18360
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrap.html',
18361
+ * autoShow: true
18362
+ * });
18363
+ * return await app.getWindow();
18364
+ * }
18365
+ * createWin().then(() => fin.Window.wrap({ uuid: 'app-1', name: 'myApp' }))
18366
+ * .then(win => console.log('wrapped window'))
18367
+ * .catch(err => console.log(err));
18368
+ * ```
18369
+ */
18370
+ wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
18371
+ /**
18372
+ * Synchronously returns a Window object that represents an existing window.
18373
+ *
18374
+ * @example
18375
+ * ```js
18376
+ * async function createWin() {
18377
+ * const app = await fin.Application.start({
18378
+ * name: 'myApp',
18379
+ * uuid: 'app-1',
18380
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.wrapSync.html',
18381
+ * autoShow: true
18382
+ * });
18383
+ * return await app.getWindow();
18384
+ * }
18385
+ * await createWin();
18386
+ * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
18387
+ * ```
18388
+ */
18389
+ wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
18390
+ /**
18391
+ * Creates a new Window.
18392
+ * @param options - Window creation options
18393
+ *
18394
+ * @example
18395
+ * ```js
18396
+ * async function createWindow() {
18397
+ * const winOption = {
18398
+ * name:'child',
18399
+ * defaultWidth: 300,
18400
+ * defaultHeight: 300,
18401
+ * url: 'https://cdn.openfin.co/docs/javascript/stable/tutorial-Window.create.html',
18402
+ * frame: true,
18403
+ * autoShow: true
18404
+ * };
18405
+ * return await fin.Window.create(winOption);
18406
+ * }
18407
+ *
18408
+ * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
18409
+ * ```
18410
+ */
18411
+ create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
18412
+ /**
18413
+ * Asynchronously returns a Window object that represents the current window
18414
+ *
18415
+ * @example
18416
+ * ```js
18417
+ * fin.Window.getCurrent()
18418
+ * .then(wnd => console.log('current window'))
18419
+ * .catch(err => console.log(err));
18420
+ *
18421
+ * ```
18422
+ */
18423
+ getCurrent(): Promise<OpenFin_2.Window>;
18424
+ /**
18425
+ * Synchronously returns a Window object that represents the current window
18426
+ *
18427
+ * @example
18428
+ * ```js
18429
+ * const wnd = fin.Window.getCurrentSync();
18430
+ * const info = await wnd.getInfo();
18431
+ * console.log(info);
18432
+ *
18433
+ * ```
18434
+ */
18435
+ getCurrentSync(): OpenFin_2.Window;
18436
+ }
18437
+
18438
+ /**
18439
+ * Generated when a child window is not responding.
18440
+ * @interface
18441
+ */
18442
+ declare type WindowNotRespondingEvent = BaseEvent_3 & {
18443
+ type: 'window-not-responding';
18444
+ };
18445
+
18446
+ /**
18447
+ * @interface
18448
+ */
18449
+ declare type WindowOptionDiff = {
18450
+ [key in keyof WindowOptions]: {
18451
+ oldVal: WindowOptions[key];
18452
+ newVal: WindowOptions[key];
18453
+ };
18454
+ };
18455
+
18456
+ /**
18457
+ * @interface
18458
+ */
18459
+ declare type WindowOptions = MutableWindowOptions & ConstWindowOptions;
18460
+
18461
+ declare type WindowOptionsChangedEvent = OpenFin_2.WindowEvents.WindowOptionsChangedEvent;
18462
+
18463
+ /**
18464
+ * @deprecated Renamed to {@link OptionsChangedEvent}.
18465
+ */
18466
+ declare type WindowOptionsChangedEvent_2 = OptionsChangedEvent;
18467
+
18468
+ declare type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
18469
+
18470
+ /**
18471
+ * Generated when a child window is responding.
18472
+ * @interface
18473
+ */
18474
+ declare type WindowRespondingEvent = BaseEvent_3 & {
18475
+ type: 'window-responding';
18476
+ };
18477
+
18478
+ /**
18479
+ * @deprecated Renamed to {@link RestoredEvent}.
18480
+ */
18481
+ declare type WindowRestoredEvent = RestoredEvent;
18482
+
18483
+ /**
18484
+ * @deprecated Renamed to {@link ShownEvent}.
18485
+ */
18486
+ declare type WindowShownEvent = ShownEvent_2;
18487
+
18488
+ /**
18489
+ * @deprecated Renamed to {@link ShowRequestedEvent}.
18490
+ */
18491
+ declare type WindowShowRequestedEvent = ShowRequestedEvent;
18492
+
18493
+ /**
18494
+ * A union of all events that emit natively on the `Window` topic, i.e. excluding those that propagate
18495
+ * from {@link OpenFin.ViewEvents}.
18496
+ */
18497
+ 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;
18498
+
18499
+ /**
18500
+ * Generated when a child window starts loading.
18501
+ * @interface
18502
+ */
18503
+ declare type WindowStartLoadEvent = BaseEvent_3 & {
18504
+ type: 'window-start-load';
18505
+ };
18506
+
18507
+ /**
18508
+ * Visibility state of a window.
18509
+ */
18510
+ declare type WindowState = 'maximized' | 'minimized' | 'normal';
18511
+
18512
+ /**
18513
+ * A view-related event that fires natively on the `Window` topic. This means that these events *do* propagate
18514
+ * to the `Application` level, with the name pattern `window-view-eventname`.
18515
+ */
18516
+ declare type WindowViewEvent = {
18517
+ viewIdentity: OpenFin_2.Identity;
18518
+ } & (ViewAttachedEvent | ViewDetachedEvent);
18519
+
18520
+ /**
18521
+ * @interface
18522
+ */
18523
+ declare type WindowViewsPrintOptions = {
18524
+ content: 'views';
18525
+ includeSelf?: boolean;
18526
+ };
18527
+
18528
+ declare type Wire = EventEmitter & {
18529
+ connect(messageReciever: MessageReceiver): Promise<any>;
18530
+ connectSync(): any;
18531
+ send(data: any): Promise<any>;
18532
+ shutdown(): Promise<void>;
18533
+ getPort(): string;
18534
+ };
18535
+
18536
+ declare type WireConstructor = {
18537
+ new (onmessage: (data: any) => void): Wire;
18538
+ };
18539
+
18540
+ /* Excluded from this release type: WithId */
18541
+
18542
+ declare interface WithInterop {
18543
+ interop: InteropClient;
18544
+ }
18545
+
18546
+ /* Excluded from this release type: WithoutId */
18547
+
18548
+ declare type WithPositioningOptions<T extends {} = {}> = T & {
18549
+ positioningOptions?: OpenFin_2.PositioningOptions;
18550
+ };
18551
+
18552
+ /* Excluded from this release type: WorkspacePlatformOptions */
18553
+
18554
+ /**
18555
+ * A generic request to write any supported data to the clipboard.
18556
+ * @interface
18557
+ */
18558
+ declare type WriteAnyClipboardRequest = BaseClipboardRequest & {
18559
+ /**
18560
+ * Data to be written
18561
+ */
18562
+ data: {
18563
+ text?: string;
18564
+ html?: string;
18565
+ rtf?: string;
18566
+ } & Partial<Pick<WriteImageClipboardRequest, 'image'>>;
18567
+ };
18568
+
18569
+ /**
18570
+ * @deprecated - instead use WriteAnyClipboardRequest
18571
+ *
18572
+ * A generic request to write any supported data to the clipboard.
18573
+ *
18574
+ * @interface
18575
+ */
18576
+ declare type WriteAnyRequestType = WriteAnyClipboardRequest;
18577
+
18578
+ /**
18579
+ * A request to write data to the clipboard.
18580
+ * @interface
18581
+ */
18582
+ declare type WriteClipboardRequest = BaseClipboardRequest & {
18583
+ /**
18584
+ * Data to write to the clipboard.
18585
+ */
18586
+ data: string;
18587
+ };
18588
+
18589
+ /**
18590
+ * @interface
18591
+ */
18592
+ declare type WriteImageClipboardRequest = BaseClipboardRequest & {
18593
+ /**
18594
+ * Can be either a base64 string, or a DataURL string. If using DataURL, the
18595
+ * supported formats are `data:image/png[;base64],` and `data:image/jpeg[;base64],`.
18596
+ * Using other image/<format> DataURLs will throw an Error.
18597
+ */
18598
+ image: string;
18599
+ };
18600
+
18601
+ /**
18602
+ * @deprecated - instead use OpenFin.WriteClipboardRequest
18603
+ *
18604
+ * A request to write data to the clipboard.
18605
+ *
18606
+ * @interface
18607
+ */
18608
+ declare type WriteRequestType = WriteClipboardRequest;
18609
+
18610
+ export { }