@openfin/core 34.78.3 → 34.78.7

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.
@@ -906,7 +906,6 @@ declare type ApplicationInfo = {
906
906
  declare class ApplicationModule extends Base {
907
907
  /**
908
908
  * Asynchronously returns an Application object that represents an existing application.
909
- * @param identity
910
909
  *
911
910
  * @example
912
911
  *
@@ -917,12 +916,10 @@ declare class ApplicationModule extends Base {
917
916
  * .catch(err => console.log(err));
918
917
  * ```
919
918
  *
920
- * @static
921
919
  */
922
920
  wrap(identity: OpenFin_2.ApplicationIdentity): Promise<OpenFin_2.Application>;
923
921
  /**
924
922
  * Synchronously returns an Application object that represents an existing application.
925
- * @param identity
926
923
  *
927
924
  * @example
928
925
  *
@@ -931,14 +928,11 @@ declare class ApplicationModule extends Base {
931
928
  * await app.close();
932
929
  * ```
933
930
  *
934
- * @static
935
931
  */
936
932
  wrapSync(identity: OpenFin_2.ApplicationIdentity): OpenFin_2.Application;
937
933
  private _create;
938
934
  /**
939
935
  * DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
940
- * @param appOptions
941
- *
942
936
  *
943
937
  * @example
944
938
  *
@@ -961,7 +955,6 @@ declare class ApplicationModule extends Base {
961
955
  create(appOptions: OpenFin_2.ApplicationCreationOptions): Promise<OpenFin_2.Application>;
962
956
  /**
963
957
  * Creates and starts a new Application.
964
- * @param appOptions
965
958
  *
966
959
  * @example
967
960
  *
@@ -977,17 +970,13 @@ declare class ApplicationModule extends Base {
977
970
  * start().then(() => console.log('Application is running')).catch(err => console.log(err));
978
971
  * ```
979
972
  *
980
- *
981
- * @static
982
973
  */
983
974
  start(appOptions: OpenFin_2.ApplicationCreationOptions): Promise<OpenFin_2.Application>;
984
975
  /**
985
976
  * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
986
977
  * Returns once the RVM is finished attempting to launch the applications.
987
- * @param applications
988
978
  * @param opts - Parameters that the RVM will use.
989
979
  *
990
- * @static
991
980
  * @example
992
981
  *
993
982
  * ```js
@@ -1037,8 +1026,6 @@ declare class ApplicationModule extends Base {
1037
1026
  * });
1038
1027
  *
1039
1028
  * ```
1040
- *
1041
- * @static
1042
1029
  */
1043
1030
  getCurrent(): Promise<OpenFin_2.Application>;
1044
1031
  /**
@@ -1059,8 +1046,6 @@ declare class ApplicationModule extends Base {
1059
1046
  * });
1060
1047
  *
1061
1048
  * ```
1062
- *
1063
- * @static
1064
1049
  */
1065
1050
  getCurrentSync(): OpenFin_2.Application;
1066
1051
  /**
@@ -1076,8 +1061,6 @@ declare class ApplicationModule extends Base {
1076
1061
  * // For a local manifest file:
1077
1062
  * fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
1078
1063
  * ```
1079
- *
1080
- * @static
1081
1064
  */
1082
1065
  startFromManifest(manifestUrl: string, opts?: OpenFin_2.RvmLaunchOptions): Promise<OpenFin_2.Application>;
1083
1066
  /**
@@ -3996,7 +3979,6 @@ declare class ExternalApplicationModule extends Base {
3996
3979
  * .then(extApp => console.log('wrapped external application'))
3997
3980
  * .catch(err => console.log(err));
3998
3981
  * ```
3999
- * @static
4000
3982
  */
4001
3983
  wrap(uuid: string): Promise<OpenFin_2.ExternalApplication>;
4002
3984
  /**
@@ -4011,7 +3993,6 @@ declare class ExternalApplicationModule extends Base {
4011
3993
  * const info = await extApp.getInfo();
4012
3994
  * console.log(info);
4013
3995
  * ```
4014
- * @static
4015
3996
  */
4016
3997
  wrapSync(uuid: string): OpenFin_2.ExternalApplication;
4017
3998
  }
@@ -4291,7 +4272,7 @@ declare type FoundInPageEvent = NamedEvent & {
4291
4272
  * The fin.Frame namespace represents a way to interact with `iframes` and facilitates the discovery of current context
4292
4273
  * (iframe or main window) as well as the ability to listen for {@link OpenFin.FrameEvents frame-specific events}.
4293
4274
  */
4294
- declare class _Frame extends EmitterBase<FrameEvents> {
4275
+ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
4295
4276
  identity: OpenFin_2.Identity;
4296
4277
  /* Excluded from this release type: __constructor */
4297
4278
  /**
@@ -4421,11 +4402,9 @@ declare type FrameEvent = {
4421
4402
  topic: 'frame';
4422
4403
  } & (FrameConnectedEvent | FrameDisconnectedEvent);
4423
4404
 
4424
- declare type FrameEvent_2 = FrameEvents_2.FrameEvent;
4425
-
4426
- declare type FrameEvents = OpenFin_2.FrameEvent;
4405
+ declare type FrameEvent_2 = FrameEvents.FrameEvent;
4427
4406
 
4428
- declare namespace FrameEvents_2 {
4407
+ declare namespace FrameEvents {
4429
4408
  export {
4430
4409
  BaseFrameEvent,
4431
4410
  FrameConnectedEvent,
@@ -4459,7 +4438,6 @@ declare class _FrameModule extends Base {
4459
4438
  * .then(frm => console.log('wrapped frame'))
4460
4439
  * .catch(err => console.log(err));
4461
4440
  * ```
4462
- * @static
4463
4441
  */
4464
4442
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Frame>;
4465
4443
  /**
@@ -4472,7 +4450,6 @@ declare class _FrameModule extends Base {
4472
4450
  * const info = await frm.getInfo();
4473
4451
  * console.log(info);
4474
4452
  * ```
4475
- * @static
4476
4453
  */
4477
4454
  wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Frame;
4478
4455
  /**
@@ -4484,7 +4461,6 @@ declare class _FrameModule extends Base {
4484
4461
  * .then(frm => console.log('current frame'))
4485
4462
  * .catch(err => console.log(err));
4486
4463
  * ```
4487
- * @static
4488
4464
  */
4489
4465
  getCurrent(): Promise<OpenFin_2.Frame>;
4490
4466
  /**
@@ -4496,7 +4472,6 @@ declare class _FrameModule extends Base {
4496
4472
  * const info = await frm.getInfo();
4497
4473
  * console.log(info);
4498
4474
  * ```
4499
- * @static
4500
4475
  */
4501
4476
  getCurrentSync(): OpenFin_2.Frame;
4502
4477
  }
@@ -5318,7 +5293,9 @@ declare class InteropBroker extends Base {
5318
5293
  * });
5319
5294
  * ```
5320
5295
  */
5321
- handleFiredIntent(intent: OpenFin_2.Intent, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
5296
+ handleFiredIntent(intent: OpenFin_2.Intent, clientIdentity: OpenFin_2.ClientIdentity & {
5297
+ entityType: OpenFin_2.EntityType;
5298
+ }): Promise<unknown>;
5322
5299
  /**
5323
5300
  * Should be called in {@link InteropBroker#handleFiredIntent InteropBroker.handleFiredIntent}.
5324
5301
  * While handleFiredIntent is responsible for launching applications, setIntentTarget is used to tell the InteropBroker which application should receive the intent when it is ready.
@@ -5347,7 +5324,7 @@ declare class InteropBroker extends Base {
5347
5324
  * More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
5348
5325
  *
5349
5326
  * @param options
5350
- * @param clientIdentity Identity of the Client making the request.
5327
+ * @param clientIdentity Identity of the Client making the request.
5351
5328
  *
5352
5329
  * @example
5353
5330
  * ```js
@@ -5363,7 +5340,9 @@ declare class InteropBroker extends Base {
5363
5340
  * });
5364
5341
  * ```
5365
5342
  */
5366
- handleInfoForIntent(options: OpenFin_2.InfoForIntentOptions, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
5343
+ handleInfoForIntent(options: OpenFin_2.InfoForIntentOptions, clientIdentity: OpenFin_2.ClientIdentity & {
5344
+ entityType: OpenFin_2.EntityType;
5345
+ }): Promise<unknown>;
5367
5346
  /**
5368
5347
  * Responsible for returning information on which Intents are meant to handle a specific Context.
5369
5348
  * Must be overridden.
@@ -5404,7 +5383,9 @@ declare class InteropBroker extends Base {
5404
5383
  * });
5405
5384
  * ```
5406
5385
  */
5407
- handleInfoForIntentsByContext(context: OpenFin_2.Context | OpenFin_2.FindIntentsByContextOptions, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
5386
+ handleInfoForIntentsByContext(context: OpenFin_2.Context | OpenFin_2.FindIntentsByContextOptions, clientIdentity: OpenFin_2.ClientIdentity & {
5387
+ entityType: OpenFin_2.EntityType;
5388
+ }): Promise<unknown>;
5408
5389
  /**
5409
5390
  * Responsible for resolving an Intent based on a specific Context.
5410
5391
  * Must be overridden.
@@ -5426,7 +5407,7 @@ declare class InteropBroker extends Base {
5426
5407
  * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
5427
5408
  *
5428
5409
  * @param contextForIntent Data passed between entities and applications.
5429
- * @param clientIdentity Identity of the Client making the request.
5410
+ * @param clientIdentity Identity of the Client making the request.
5430
5411
  *
5431
5412
  * @example
5432
5413
  * ```js
@@ -5442,7 +5423,9 @@ declare class InteropBroker extends Base {
5442
5423
  * });
5443
5424
  * ```
5444
5425
  */
5445
- handleFiredIntentForContext(contextForIntent: OpenFin_2.ContextForIntent, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
5426
+ handleFiredIntentForContext(contextForIntent: OpenFin_2.ContextForIntent, clientIdentity: OpenFin_2.ClientIdentity & {
5427
+ entityType: OpenFin_2.EntityType;
5428
+ }): Promise<unknown>;
5446
5429
  /**
5447
5430
  * Provides the identity of any Interop Client that disconnects from the Interop Broker. It is meant to be overriden.
5448
5431
  * @param clientIdentity
@@ -5476,7 +5459,7 @@ declare class InteropBroker extends Base {
5476
5459
  /**
5477
5460
  * Responsible for resolving the fdc3.findInstances call.
5478
5461
  * Must be overridden
5479
- * @param app AppIdentifier that was passed to fdc3.findInstances
5462
+ * @param app AppIdentifier that was passed to fdc3.findInstances
5480
5463
  * @param clientIdentity Identity of the Client making the request.
5481
5464
  */
5482
5465
  fdc3HandleFindInstances(app: AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
@@ -5501,7 +5484,7 @@ declare class InteropBroker extends Base {
5501
5484
  * fin.Platform.init({
5502
5485
  * interopOverride: async (InteropBroker) => {
5503
5486
  * class Override extends InteropBroker {
5504
- * async invokeContextHandler(options, clientIdentity) {
5487
+ * async invokeContextHandler(clientIdentity, handlerId, context) {
5505
5488
  * return super.invokeContextHandler(clientIdentity, handlerId, {
5506
5489
  * ...context,
5507
5490
  * contextMetadata: {
@@ -5533,7 +5516,7 @@ declare class InteropBroker extends Base {
5533
5516
  * fin.Platform.init({
5534
5517
  * interopOverride: async (InteropBroker) => {
5535
5518
  * class Override extends InteropBroker {
5536
- * async invokeIntentHandler(options, clientIdentity) {
5519
+ * async invokeIntentHandler(clientIdentity, handlerId, context) {
5537
5520
  * const { context } = intent;
5538
5521
  * return super.invokeIntentHandler(clientIdentity, handlerId, {
5539
5522
  * ...intent,
@@ -6212,7 +6195,6 @@ declare class InteropModule extends Base {
6212
6195
  * const contextGroups = await interopBroker.getContextGroups();
6213
6196
  * console.log(contextGroups);
6214
6197
  * ```
6215
- * @static
6216
6198
  */
6217
6199
  init(name: string, override?: OpenFin_2.OverrideCallback<InteropBroker> | OpenFin_2.ConstructorOverride<InteropBroker>[]): Promise<InteropBroker>;
6218
6200
  /**
@@ -6234,7 +6216,6 @@ declare class InteropModule extends Base {
6234
6216
  * const contextGroupInfo = await client.getInfoForContextGroup();
6235
6217
  * console.log(contextGroupInfo);
6236
6218
  * ```
6237
- * @static
6238
6219
  */
6239
6220
  connectSync(name: string, interopConfig?: OpenFin_2.InteropConfig): InteropClient;
6240
6221
  }
@@ -6664,7 +6645,6 @@ declare class LayoutModule extends Base {
6664
6645
  #private;
6665
6646
  /**
6666
6647
  * Asynchronously returns a Layout object that represents a Window's layout.
6667
- * @param identity
6668
6648
  *
6669
6649
  * @example
6670
6650
  * ```js
@@ -6681,12 +6661,10 @@ declare class LayoutModule extends Base {
6681
6661
  * // Use wrapped instance to control layout, e.g.:
6682
6662
  * const layoutConfig = await layout.getConfig();
6683
6663
  * ```
6684
- * @static
6685
6664
  */
6686
6665
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
6687
6666
  /**
6688
6667
  * Synchronously returns a Layout object that represents a Window's layout.
6689
- * @param identity
6690
6668
  *
6691
6669
  * @example
6692
6670
  * ```js
@@ -6703,7 +6681,6 @@ declare class LayoutModule extends Base {
6703
6681
  * // Use wrapped instance to control layout, e.g.:
6704
6682
  * const layoutConfig = await layout.getConfig();
6705
6683
  * ```
6706
- * @static
6707
6684
  */
6708
6685
  wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Layout;
6709
6686
  /**
@@ -6715,7 +6692,6 @@ declare class LayoutModule extends Base {
6715
6692
  * // Use wrapped instance to control layout, e.g.:
6716
6693
  * const layoutConfig = await layout.getConfig();
6717
6694
  * ```
6718
- * @static
6719
6695
  */
6720
6696
  getCurrent(): Promise<OpenFin_2.Layout>;
6721
6697
  /**
@@ -6730,7 +6706,6 @@ declare class LayoutModule extends Base {
6730
6706
  * // Use wrapped instance to control layout, e.g.:
6731
6707
  * const layoutConfig = await layout.getConfig();
6732
6708
  * ```
6733
- * @static
6734
6709
  */
6735
6710
  getCurrentSync(): OpenFin_2.Layout;
6736
6711
  /**
@@ -6770,7 +6745,6 @@ declare class LayoutModule extends Base {
6770
6745
  * // the window must have been created with a layout in its window options
6771
6746
  * const layout = await fin.Platform.Layout.init({ containerId });
6772
6747
  * ```
6773
- * @static
6774
6748
  */
6775
6749
  init: (options?: InitLayoutOptions) => Promise<OpenFin_2.Layout>;
6776
6750
  }
@@ -7626,7 +7600,7 @@ declare namespace OpenFin_2 {
7626
7600
  AutoResizeOptions,
7627
7601
  InteropConfig,
7628
7602
  ViewInfo,
7629
- UpdatableViewOptions_2 as UpdatableViewOptions,
7603
+ UpdatableViewOptions,
7630
7604
  ViewCreationOptions,
7631
7605
  MutableViewOptions,
7632
7606
  ViewOptions,
@@ -7821,7 +7795,7 @@ declare namespace OpenFin_2 {
7821
7795
  WindowEvents,
7822
7796
  ViewEvents,
7823
7797
  GlobalHotkeyEvents,
7824
- FrameEvents_2 as FrameEvents,
7798
+ FrameEvents,
7825
7799
  PlatformEvents,
7826
7800
  ExternalApplicationEvents,
7827
7801
  BaseEvent_2 as BaseEvent,
@@ -7830,7 +7804,7 @@ declare namespace OpenFin_2 {
7830
7804
  SystemEvent_2 as SystemEvent,
7831
7805
  ApplicationEvent_2 as ApplicationEvent,
7832
7806
  WindowEvent_2 as WindowEvent,
7833
- ViewEvent_3 as ViewEvent,
7807
+ ViewEvent_2 as ViewEvent,
7834
7808
  GlobalHotkeyEvent_2 as GlobalHotkeyEvent,
7835
7809
  FrameEvent_2 as FrameEvent,
7836
7810
  PlatformEvent_2 as PlatformEvent,
@@ -8590,12 +8564,10 @@ declare class PlatformModule extends Base {
8590
8564
  * fin.Platform.init({overrideCallback});
8591
8565
  * ```
8592
8566
  * @experimental
8593
- * @static
8594
8567
  */
8595
8568
  init(options?: OpenFin_2.InitPlatformOptions): Promise<void>;
8596
8569
  /**
8597
8570
  * Asynchronously returns a Platform object that represents an existing platform.
8598
- * @param identity
8599
8571
  *
8600
8572
  * @example
8601
8573
  * ```js
@@ -8604,12 +8576,10 @@ declare class PlatformModule extends Base {
8604
8576
  * // Use wrapped instance to control layout, e.g.:
8605
8577
  * const snapshot = await platform.getSnapshot();
8606
8578
  * ```
8607
- * @static
8608
8579
  */
8609
8580
  wrap(identity: OpenFin_2.ApplicationIdentity): Promise<OpenFin_2.Platform>;
8610
8581
  /**
8611
8582
  * Synchronously returns a Platform object that represents an existing platform.
8612
- * @param identity
8613
8583
  *
8614
8584
  * @example
8615
8585
  * ```js
@@ -8618,7 +8588,6 @@ declare class PlatformModule extends Base {
8618
8588
  * // Use wrapped instance to control layout, e.g.:
8619
8589
  * const snapshot = await platform.getSnapshot();
8620
8590
  * ```
8621
- * @static
8622
8591
  */
8623
8592
  wrapSync(identity: OpenFin_2.ApplicationIdentity): OpenFin_2.Platform;
8624
8593
  /**
@@ -8630,7 +8599,6 @@ declare class PlatformModule extends Base {
8630
8599
  * // Use wrapped instance to control layout, e.g.:
8631
8600
  * const snapshot = await platform.getSnapshot();
8632
8601
  * ```
8633
- * @static
8634
8602
  */
8635
8603
  getCurrent(): Promise<OpenFin_2.Platform>;
8636
8604
  /**
@@ -8642,13 +8610,11 @@ declare class PlatformModule extends Base {
8642
8610
  * // Use wrapped instance to control layout, e.g.:
8643
8611
  * const snapshot = await platform.getSnapshot();
8644
8612
  * ```
8645
- * @static
8646
8613
  */
8647
8614
  getCurrentSync(): OpenFin_2.Platform;
8648
8615
  /**
8649
8616
  * Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
8650
8617
  * be used to launch content into the platform. Promise will reject if the platform is already running.
8651
- * @param platformOptions
8652
8618
  *
8653
8619
  * @example
8654
8620
  * ```js
@@ -8669,7 +8635,6 @@ declare class PlatformModule extends Base {
8669
8635
  * console.error(e);
8670
8636
  * }
8671
8637
  * ```
8672
- * @static
8673
8638
  */
8674
8639
  start(platformOptions: OpenFin_2.PlatformOptions): Promise<OpenFin_2.Platform>;
8675
8640
  /**
@@ -8694,7 +8659,6 @@ declare class PlatformModule extends Base {
8694
8659
  * console.error(e);
8695
8660
  * }
8696
8661
  * ```
8697
- * @static
8698
8662
  */
8699
8663
  startFromManifest(manifestUrl: string, opts?: OpenFin_2.RvmLaunchOptions): Promise<OpenFin_2.Platform>;
8700
8664
  }
@@ -10386,7 +10350,6 @@ declare class SnapshotSource<T = any> extends Base {
10386
10350
  declare class SnapshotSourceModule extends Base {
10387
10351
  /**
10388
10352
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
10389
- * @param provider
10390
10353
  *
10391
10354
  * @example
10392
10355
  * ```js
@@ -10403,12 +10366,10 @@ declare class SnapshotSourceModule extends Base {
10403
10366
  *
10404
10367
  * await fin.SnapshotSource.init(snapshotProvider);
10405
10368
  * ```
10406
- * @static
10407
10369
  */
10408
10370
  init<T = any>(provider: OpenFin_2.SnapshotProvider<T>): Promise<void>;
10409
10371
  /**
10410
10372
  * Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
10411
- * @param identity
10412
10373
  *
10413
10374
  * @example
10414
10375
  * ```js
@@ -10416,12 +10377,10 @@ declare class SnapshotSourceModule extends Base {
10416
10377
  * // Use wrapped instance's getSnapshot method, e.g.:
10417
10378
  * const snapshot = await snapshotSource.getSnapshot();
10418
10379
  * ```
10419
- * @static
10420
10380
  */
10421
10381
  wrapSync(identity: OpenFin_2.ApplicationIdentity): SnapshotSource;
10422
10382
  /**
10423
10383
  * Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
10424
- * @param identity
10425
10384
  *
10426
10385
  * @example
10427
10386
  * ```js
@@ -10429,7 +10388,6 @@ declare class SnapshotSourceModule extends Base {
10429
10388
  * // Use wrapped instance's getSnapshot method, e.g.:
10430
10389
  * const snapshot = await snapshotSource.getSnapshot();
10431
10390
  * ```
10432
- * @static
10433
10391
  */
10434
10392
  wrap(identity: OpenFin_2.ApplicationIdentity): Promise<SnapshotSource>;
10435
10393
  }
@@ -10705,7 +10663,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
10705
10663
  * ```js
10706
10664
  * fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
10707
10665
  * ```
10708
- * @static
10709
10666
  */
10710
10667
  getUniqueUserId(): Promise<string>;
10711
10668
  /**
@@ -11742,7 +11699,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
11742
11699
  * }
11743
11700
  * });
11744
11701
  * ```
11745
- * @static
11746
11702
  */
11747
11703
  launchManifest(manifestUrl: string, opts?: OpenFin_2.RvmLaunchOptions): Promise<OpenFin_2.Manifest>;
11748
11704
  /**
@@ -12381,12 +12337,10 @@ declare type UnregisteredEvent = BaseEvent & {
12381
12337
  type: 'unregistered';
12382
12338
  };
12383
12339
 
12384
- declare type UpdatableViewOptions = OpenFin_2.UpdatableViewOptions;
12385
-
12386
12340
  /**
12387
12341
  * View options that can be updated after creation.
12388
12342
  */
12389
- declare type UpdatableViewOptions_2 = Partial<MutableViewOptions>;
12343
+ declare type UpdatableViewOptions = Partial<MutableViewOptions>;
12390
12344
 
12391
12345
  declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
12392
12346
 
@@ -12603,17 +12557,13 @@ declare type View = OpenFin_2.View;
12603
12557
  *
12604
12558
  * 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.
12605
12559
  */
12606
- declare class View_2 extends WebContents<ViewEvent> {
12560
+ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
12607
12561
  #private;
12608
12562
  identity: OpenFin_2.Identity;
12609
12563
  /* Excluded from this release type: __constructor */
12610
12564
  /**
12611
12565
  * Focuses the view
12612
12566
  *
12613
- * @function focus
12614
- * @memberof View
12615
- * @emits focused
12616
- * @instance
12617
12567
  * @example
12618
12568
  * ```js
12619
12569
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -12897,7 +12847,6 @@ declare class View_2 extends WebContents<ViewEvent> {
12897
12847
  getOptions: () => Promise<OpenFin_2.ViewOptions>;
12898
12848
  /**
12899
12849
  * Updates the view's options.
12900
- * @param options
12901
12850
  *
12902
12851
  * @example
12903
12852
  * ```js
@@ -12932,11 +12881,10 @@ declare class View_2 extends WebContents<ViewEvent> {
12932
12881
  * ```
12933
12882
  * @experimental
12934
12883
  */
12935
- updateOptions: (options: UpdatableViewOptions) => Promise<void>;
12884
+ updateOptions: (options: OpenFin_2.UpdatableViewOptions) => Promise<void>;
12936
12885
  /**
12937
12886
  * Retrieves the window the view is currently attached to.
12938
12887
  *
12939
- * @experimental
12940
12888
  * @example
12941
12889
  * ```js
12942
12890
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -12944,6 +12892,7 @@ declare class View_2 extends WebContents<ViewEvent> {
12944
12892
  * .then(win => console.log('current window', win))
12945
12893
  * .catch(err => console.log(err));)
12946
12894
  * ```
12895
+ * @experimental
12947
12896
  */
12948
12897
  getCurrentWindow: () => Promise<OpenFin_2.Window>;
12949
12898
  /**
@@ -13018,16 +12967,14 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
13018
12967
  previousTarget: OpenFin_2.Identity;
13019
12968
  };
13020
12969
 
13021
- declare type ViewEvent = OpenFin_2.ViewEvent;
13022
-
13023
12970
  /**
13024
12971
  * A View event.
13025
12972
  */
13026
- declare type ViewEvent_2 = {
12973
+ declare type ViewEvent = {
13027
12974
  topic: 'view';
13028
12975
  } & (NonPropagatedViewEvent | WillPropagateViewEvent);
13029
12976
 
13030
- declare type ViewEvent_3 = ViewEvents.ViewEvent;
12977
+ declare type ViewEvent_2 = ViewEvents.ViewEvent;
13031
12978
 
13032
12979
  declare namespace ViewEvents {
13033
12980
  export {
@@ -13041,7 +12988,7 @@ declare namespace ViewEvents {
13041
12988
  HotkeyEvent,
13042
12989
  ShownEvent,
13043
12990
  WillPropagateViewEvent,
13044
- ViewEvent_2 as ViewEvent,
12991
+ ViewEvent,
13045
12992
  ViewEventType,
13046
12993
  PropagatedViewEvent,
13047
12994
  PropagatedViewEventType
@@ -13051,7 +12998,7 @@ declare namespace ViewEvents {
13051
12998
  /**
13052
12999
  * A View event type.
13053
13000
  */
13054
- declare type ViewEventType = ViewEvent_2['type'];
13001
+ declare type ViewEventType = ViewEvent['type'];
13055
13002
 
13056
13003
  declare type ViewInfo = {
13057
13004
  canNavigateBack: boolean;
@@ -13090,12 +13037,10 @@ declare class ViewModule extends Base {
13090
13037
  * ```
13091
13038
  * Note that created views needs to navigate somewhere for them to actually render a website.
13092
13039
  * @experimental
13093
- * @static
13094
13040
  */
13095
13041
  create(options: OpenFin_2.ViewCreationOptions): Promise<OpenFin_2.View>;
13096
13042
  /**
13097
13043
  * Asynchronously returns a View object that represents an existing view.
13098
- * @param identity
13099
13044
  *
13100
13045
  * @example
13101
13046
  * ```js
@@ -13104,12 +13049,10 @@ declare class ViewModule extends Base {
13104
13049
  * .catch(err => console.log(err));
13105
13050
  * ```
13106
13051
  * @experimental
13107
- * @static
13108
13052
  */
13109
13053
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.View>;
13110
13054
  /**
13111
13055
  * Synchronously returns a View object that represents an existing view.
13112
- * @param identity
13113
13056
  *
13114
13057
  * @example
13115
13058
  * ```js
@@ -13117,7 +13060,6 @@ declare class ViewModule extends Base {
13117
13060
  * await view.hide();
13118
13061
  * ```
13119
13062
  * @experimental
13120
- * @static
13121
13063
  */
13122
13064
  wrapSync(identity: OpenFin_2.Identity): OpenFin_2.View;
13123
13065
  /**
@@ -13131,7 +13073,6 @@ declare class ViewModule extends Base {
13131
13073
  *
13132
13074
  * ```
13133
13075
  * @experimental
13134
- * @static
13135
13076
  */
13136
13077
  getCurrent(): Promise<OpenFin_2.View>;
13137
13078
  /**
@@ -13144,7 +13085,6 @@ declare class ViewModule extends Base {
13144
13085
  *
13145
13086
  * ```
13146
13087
  * @experimental
13147
- * @static
13148
13088
  */
13149
13089
  getCurrentSync(): OpenFin_2.View;
13150
13090
  }
@@ -13264,10 +13204,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13264
13204
  constructor(wire: Transport, identity: OpenFin_2.Identity, entityType: string);
13265
13205
  /**
13266
13206
  * Gets a base64 encoded image of all or part of the WebContents.
13267
- * @function capturePage
13268
13207
  * @param options Options for the capturePage call.
13269
- * @memberOf View
13270
- * @instance
13271
13208
  *
13272
13209
  * @example
13273
13210
  *
@@ -13318,9 +13255,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13318
13255
  * Executes Javascript on the WebContents, restricted to contents you own or contents owned by
13319
13256
  * applications you have created.
13320
13257
  * @param code JavaScript code to be executed on the view.
13321
- * @function executeJavaScript
13322
- * @memberOf View
13323
- * @instance
13324
13258
  *
13325
13259
  * @example
13326
13260
  * View:
@@ -13352,9 +13286,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13352
13286
  executeJavaScript(code: string): Promise<void>;
13353
13287
  /**
13354
13288
  * Returns the zoom level of the WebContents.
13355
- * @function getZoomLevel
13356
- * @memberOf View
13357
- * @instance
13358
13289
  *
13359
13290
  * @example
13360
13291
  * View:
@@ -13391,9 +13322,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13391
13322
  /**
13392
13323
  * Sets the zoom level of the WebContents.
13393
13324
  * @param level The zoom level
13394
- * @function setZoomLevel
13395
- * @memberOf View
13396
- * @instance
13397
13325
  *
13398
13326
  * @example
13399
13327
  * View:
@@ -13433,9 +13361,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13433
13361
  * @remarks The url must contain the protocol prefix such as http:// or https://.
13434
13362
  * @param url - The URL to navigate the WebContents to.
13435
13363
  *
13436
- * @function navigate
13437
- * @memberof View
13438
- * @instance
13439
13364
  * @example
13440
13365
  * View:
13441
13366
  * ```js
@@ -13467,9 +13392,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13467
13392
  navigate(url: string): Promise<void>;
13468
13393
  /**
13469
13394
  * Navigates the WebContents back one page.
13470
- * @function navigateBack
13471
- * @memberOf View
13472
- * @instance
13473
13395
  *
13474
13396
  * @example
13475
13397
  * View:
@@ -13495,9 +13417,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13495
13417
  navigateBack(): Promise<void>;
13496
13418
  /**
13497
13419
  * Navigates the WebContents forward one page.
13498
- * @function navigateForward
13499
- * @memberOf View
13500
- * @instance
13501
13420
  *
13502
13421
  * @example
13503
13422
  * View:
@@ -13525,9 +13444,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13525
13444
  navigateForward(): Promise<void>;
13526
13445
  /**
13527
13446
  * Stops any current navigation the WebContents is performing.
13528
- * @function stopNavigation
13529
- * @memberOf View
13530
- * @instance
13531
13447
  *
13532
13448
  * @example
13533
13449
  * View:
@@ -13553,9 +13469,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13553
13469
  stopNavigation(): Promise<void>;
13554
13470
  /**
13555
13471
  * Reloads the WebContents
13556
- * @function reload
13557
- * @memberOf View
13558
- * @instance
13559
13472
  *
13560
13473
  * @example
13561
13474
  * View:
@@ -13592,9 +13505,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13592
13505
  /**
13593
13506
  * Prints the WebContents.
13594
13507
  * @param options Printer Options
13595
- * @function print
13596
- * @memberOf View
13597
- * @instance
13598
13508
  *
13599
13509
  * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
13600
13510
  * is empty and the default settings for printing.
@@ -13615,9 +13525,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13615
13525
  * Find and highlight text on a page.
13616
13526
  * @param searchTerm Term to find in page
13617
13527
  * @param options Search options
13618
- * @function findInPage
13619
- * @memberOf View
13620
- * @instance
13621
13528
  *
13622
13529
  * @remarks By default, each subsequent call will highlight the next text that matches the search term.
13623
13530
  *
@@ -13698,9 +13605,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13698
13605
  /**
13699
13606
  * Returns an array with all system printers
13700
13607
  * @deprecated use System.getPrinters instead
13701
- * @function getPrinters
13702
- * @memberOf View
13703
- * @instance
13704
13608
  *
13705
13609
  * @example
13706
13610
  * View:
@@ -13741,10 +13645,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13741
13645
  /**
13742
13646
  * Gives focus to the WebContents.
13743
13647
  *
13744
- * @function focus
13745
- * @emits focused
13746
- * @memberOf Window
13747
- * @instance
13748
13648
  * @example
13749
13649
  * ```js
13750
13650
  * async function focusWindow() {
@@ -13766,9 +13666,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13766
13666
  }): Promise<void>;
13767
13667
  /**
13768
13668
  * Shows the Chromium Developer Tools
13769
- * @function showDeveloperTools
13770
- * @memberOf View
13771
- * @instance
13772
13669
  *
13773
13670
  * @example
13774
13671
  * View:
@@ -13801,10 +13698,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13801
13698
  *
13802
13699
  * @remarks This includes any iframes associated with the WebContents
13803
13700
  *
13804
- * @function getProcessInfo
13805
- * @memberOf View
13806
- * @instance
13807
- *
13808
13701
  * @example
13809
13702
  * View:
13810
13703
  * ```js
@@ -13821,9 +13714,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13821
13714
  getProcessInfo(): Promise<OpenFin_2.EntityProcessDetails>;
13822
13715
  /**
13823
13716
  * Retrieves information on all Shared Workers.
13824
- * @function getSharedWorkers
13825
- * @memberOf View
13826
- * @instance
13827
13717
  *
13828
13718
  * @example
13829
13719
  * View:
@@ -13856,9 +13746,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13856
13746
  getSharedWorkers(): Promise<OpenFin_2.SharedWorkerInfo[]>;
13857
13747
  /**
13858
13748
  * Opens the developer tools for the shared worker context.
13859
- * @function inspectSharedWorker
13860
- * @memberOf View
13861
- * @instance
13862
13749
  *
13863
13750
  * @example
13864
13751
  * View:
@@ -13892,9 +13779,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13892
13779
  /**
13893
13780
  * Inspects the shared worker based on its ID.
13894
13781
  * @param workerId - The id of the shared worker.
13895
- * @function inspectSharedWorkerById
13896
- * @memberOf View
13897
- * @instance
13898
13782
  *
13899
13783
  * @example
13900
13784
  * View:
@@ -13929,9 +13813,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13929
13813
  inspectSharedWorkerById(workerId: string): Promise<void>;
13930
13814
  /**
13931
13815
  * Opens the developer tools for the service worker context.
13932
- * @function inspectServiceWorker
13933
- * @memberOf View
13934
- * @instance
13935
13816
  *
13936
13817
  * @example
13937
13818
  * View:
@@ -14168,11 +14049,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14168
14049
  * onPopupReady: popupWindowCallback;
14169
14050
  * });
14170
14051
  * ```
14171
- * @function showPopupWindow
14172
- * @memberOf View
14173
- * @instance
14174
- * @param options
14175
- *
14176
14052
  */
14177
14053
  showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
14178
14054
  }
@@ -16007,7 +15883,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16007
15883
  declare class _WindowModule extends Base {
16008
15884
  /**
16009
15885
  * Asynchronously returns a Window object that represents an existing window.
16010
- * @param identity
16011
15886
  *
16012
15887
  * @example
16013
15888
  * ```js
@@ -16024,12 +15899,10 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16024
15899
  * .then(win => console.log('wrapped window'))
16025
15900
  * .catch(err => console.log(err));
16026
15901
  * ```
16027
- * @static
16028
15902
  */
16029
15903
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
16030
15904
  /**
16031
15905
  * Synchronously returns a Window object that represents an existing window.
16032
- * @param identity
16033
15906
  *
16034
15907
  * @example
16035
15908
  * ```js
@@ -16045,7 +15918,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16045
15918
  * await createWin();
16046
15919
  * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
16047
15920
  * ```
16048
- * @static
16049
15921
  */
16050
15922
  wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
16051
15923
  /**
@@ -16068,7 +15940,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16068
15940
  *
16069
15941
  * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
16070
15942
  * ```
16071
- * @static
16072
15943
  */
16073
15944
  create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
16074
15945
  /**
@@ -16081,7 +15952,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16081
15952
  * .catch(err => console.log(err));
16082
15953
  *
16083
15954
  * ```
16084
- * @static
16085
15955
  */
16086
15956
  getCurrent(): Promise<OpenFin_2.Window>;
16087
15957
  /**
@@ -16094,7 +15964,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16094
15964
  * console.log(info);
16095
15965
  *
16096
15966
  * ```
16097
- * @static
16098
15967
  */
16099
15968
  getCurrentSync(): OpenFin_2.Window;
16100
15969
  }