@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.
package/out/mock.d.ts CHANGED
@@ -912,7 +912,6 @@ declare type ApplicationInfo = {
912
912
  declare class ApplicationModule extends Base {
913
913
  /**
914
914
  * Asynchronously returns an Application object that represents an existing application.
915
- * @param identity
916
915
  *
917
916
  * @example
918
917
  *
@@ -923,12 +922,10 @@ declare class ApplicationModule extends Base {
923
922
  * .catch(err => console.log(err));
924
923
  * ```
925
924
  *
926
- * @static
927
925
  */
928
926
  wrap(identity: OpenFin_2.ApplicationIdentity): Promise<OpenFin_2.Application>;
929
927
  /**
930
928
  * Synchronously returns an Application object that represents an existing application.
931
- * @param identity
932
929
  *
933
930
  * @example
934
931
  *
@@ -937,14 +934,11 @@ declare class ApplicationModule extends Base {
937
934
  * await app.close();
938
935
  * ```
939
936
  *
940
- * @static
941
937
  */
942
938
  wrapSync(identity: OpenFin_2.ApplicationIdentity): OpenFin_2.Application;
943
939
  private _create;
944
940
  /**
945
941
  * DEPRECATED method to create a new Application. Use {@link Application.ApplicationModule.start Application.start} instead.
946
- * @param appOptions
947
- *
948
942
  *
949
943
  * @example
950
944
  *
@@ -967,7 +961,6 @@ declare class ApplicationModule extends Base {
967
961
  create(appOptions: OpenFin_2.ApplicationCreationOptions): Promise<OpenFin_2.Application>;
968
962
  /**
969
963
  * Creates and starts a new Application.
970
- * @param appOptions
971
964
  *
972
965
  * @example
973
966
  *
@@ -983,17 +976,13 @@ declare class ApplicationModule extends Base {
983
976
  * start().then(() => console.log('Application is running')).catch(err => console.log(err));
984
977
  * ```
985
978
  *
986
- *
987
- * @static
988
979
  */
989
980
  start(appOptions: OpenFin_2.ApplicationCreationOptions): Promise<OpenFin_2.Application>;
990
981
  /**
991
982
  * Asynchronously starts a batch of applications given an array of application identifiers and manifestUrls.
992
983
  * Returns once the RVM is finished attempting to launch the applications.
993
- * @param applications
994
984
  * @param opts - Parameters that the RVM will use.
995
985
  *
996
- * @static
997
986
  * @example
998
987
  *
999
988
  * ```js
@@ -1043,8 +1032,6 @@ declare class ApplicationModule extends Base {
1043
1032
  * });
1044
1033
  *
1045
1034
  * ```
1046
- *
1047
- * @static
1048
1035
  */
1049
1036
  getCurrent(): Promise<OpenFin_2.Application>;
1050
1037
  /**
@@ -1065,8 +1052,6 @@ declare class ApplicationModule extends Base {
1065
1052
  * });
1066
1053
  *
1067
1054
  * ```
1068
- *
1069
- * @static
1070
1055
  */
1071
1056
  getCurrentSync(): OpenFin_2.Application;
1072
1057
  /**
@@ -1082,8 +1067,6 @@ declare class ApplicationModule extends Base {
1082
1067
  * // For a local manifest file:
1083
1068
  * fin.Application.startFromManifest('file:///C:/somefolder/app.json').then(app => console.log('App is running')).catch(err => console.log(err));
1084
1069
  * ```
1085
- *
1086
- * @static
1087
1070
  */
1088
1071
  startFromManifest(manifestUrl: string, opts?: OpenFin_2.RvmLaunchOptions): Promise<OpenFin_2.Application>;
1089
1072
  /**
@@ -4106,7 +4089,6 @@ declare class ExternalApplicationModule extends Base {
4106
4089
  * .then(extApp => console.log('wrapped external application'))
4107
4090
  * .catch(err => console.log(err));
4108
4091
  * ```
4109
- * @static
4110
4092
  */
4111
4093
  wrap(uuid: string): Promise<OpenFin_2.ExternalApplication>;
4112
4094
  /**
@@ -4121,7 +4103,6 @@ declare class ExternalApplicationModule extends Base {
4121
4103
  * const info = await extApp.getInfo();
4122
4104
  * console.log(info);
4123
4105
  * ```
4124
- * @static
4125
4106
  */
4126
4107
  wrapSync(uuid: string): OpenFin_2.ExternalApplication;
4127
4108
  }
@@ -4401,7 +4382,7 @@ declare type FoundInPageEvent = NamedEvent & {
4401
4382
  * The fin.Frame namespace represents a way to interact with `iframes` and facilitates the discovery of current context
4402
4383
  * (iframe or main window) as well as the ability to listen for {@link OpenFin.FrameEvents frame-specific events}.
4403
4384
  */
4404
- declare class _Frame extends EmitterBase<FrameEvents> {
4385
+ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
4405
4386
  identity: OpenFin_2.Identity;
4406
4387
  /**
4407
4388
  * @internal
@@ -4534,11 +4515,9 @@ declare type FrameEvent = {
4534
4515
  topic: 'frame';
4535
4516
  } & (FrameConnectedEvent | FrameDisconnectedEvent);
4536
4517
 
4537
- declare type FrameEvent_2 = FrameEvents_2.FrameEvent;
4518
+ declare type FrameEvent_2 = FrameEvents.FrameEvent;
4538
4519
 
4539
- declare type FrameEvents = OpenFin_2.FrameEvent;
4540
-
4541
- declare namespace FrameEvents_2 {
4520
+ declare namespace FrameEvents {
4542
4521
  export {
4543
4522
  BaseFrameEvent,
4544
4523
  FrameConnectedEvent,
@@ -4572,7 +4551,6 @@ declare class _FrameModule extends Base {
4572
4551
  * .then(frm => console.log('wrapped frame'))
4573
4552
  * .catch(err => console.log(err));
4574
4553
  * ```
4575
- * @static
4576
4554
  */
4577
4555
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Frame>;
4578
4556
  /**
@@ -4585,7 +4563,6 @@ declare class _FrameModule extends Base {
4585
4563
  * const info = await frm.getInfo();
4586
4564
  * console.log(info);
4587
4565
  * ```
4588
- * @static
4589
4566
  */
4590
4567
  wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Frame;
4591
4568
  /**
@@ -4597,7 +4574,6 @@ declare class _FrameModule extends Base {
4597
4574
  * .then(frm => console.log('current frame'))
4598
4575
  * .catch(err => console.log(err));
4599
4576
  * ```
4600
- * @static
4601
4577
  */
4602
4578
  getCurrent(): Promise<OpenFin_2.Frame>;
4603
4579
  /**
@@ -4609,7 +4585,6 @@ declare class _FrameModule extends Base {
4609
4585
  * const info = await frm.getInfo();
4610
4586
  * console.log(info);
4611
4587
  * ```
4612
- * @static
4613
4588
  */
4614
4589
  getCurrentSync(): OpenFin_2.Frame;
4615
4590
  }
@@ -5452,7 +5427,9 @@ declare class InteropBroker extends Base {
5452
5427
  * });
5453
5428
  * ```
5454
5429
  */
5455
- handleFiredIntent(intent: OpenFin_2.Intent, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
5430
+ handleFiredIntent(intent: OpenFin_2.Intent, clientIdentity: OpenFin_2.ClientIdentity & {
5431
+ entityType: OpenFin_2.EntityType;
5432
+ }): Promise<unknown>;
5456
5433
  /**
5457
5434
  * Should be called in {@link InteropBroker#handleFiredIntent InteropBroker.handleFiredIntent}.
5458
5435
  * While handleFiredIntent is responsible for launching applications, setIntentTarget is used to tell the InteropBroker which application should receive the intent when it is ready.
@@ -5481,7 +5458,7 @@ declare class InteropBroker extends Base {
5481
5458
  * More information on the AppIntent type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/AppIntent).
5482
5459
  *
5483
5460
  * @param options
5484
- * @param clientIdentity Identity of the Client making the request.
5461
+ * @param clientIdentity Identity of the Client making the request.
5485
5462
  *
5486
5463
  * @example
5487
5464
  * ```js
@@ -5497,7 +5474,9 @@ declare class InteropBroker extends Base {
5497
5474
  * });
5498
5475
  * ```
5499
5476
  */
5500
- handleInfoForIntent(options: OpenFin_2.InfoForIntentOptions, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
5477
+ handleInfoForIntent(options: OpenFin_2.InfoForIntentOptions, clientIdentity: OpenFin_2.ClientIdentity & {
5478
+ entityType: OpenFin_2.EntityType;
5479
+ }): Promise<unknown>;
5501
5480
  /**
5502
5481
  * Responsible for returning information on which Intents are meant to handle a specific Context.
5503
5482
  * Must be overridden.
@@ -5538,7 +5517,9 @@ declare class InteropBroker extends Base {
5538
5517
  * });
5539
5518
  * ```
5540
5519
  */
5541
- handleInfoForIntentsByContext(context: OpenFin_2.Context | OpenFin_2.FindIntentsByContextOptions, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
5520
+ handleInfoForIntentsByContext(context: OpenFin_2.Context | OpenFin_2.FindIntentsByContextOptions, clientIdentity: OpenFin_2.ClientIdentity & {
5521
+ entityType: OpenFin_2.EntityType;
5522
+ }): Promise<unknown>;
5542
5523
  /**
5543
5524
  * Responsible for resolving an Intent based on a specific Context.
5544
5525
  * Must be overridden.
@@ -5560,7 +5541,7 @@ declare class InteropBroker extends Base {
5560
5541
  * More information on the IntentResolution type can be found in the [FDC3 documentation](https://fdc3.finos.org/docs/api/ref/IntentResolution).
5561
5542
  *
5562
5543
  * @param contextForIntent Data passed between entities and applications.
5563
- * @param clientIdentity Identity of the Client making the request.
5544
+ * @param clientIdentity Identity of the Client making the request.
5564
5545
  *
5565
5546
  * @example
5566
5547
  * ```js
@@ -5576,7 +5557,9 @@ declare class InteropBroker extends Base {
5576
5557
  * });
5577
5558
  * ```
5578
5559
  */
5579
- handleFiredIntentForContext(contextForIntent: OpenFin_2.ContextForIntent, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
5560
+ handleFiredIntentForContext(contextForIntent: OpenFin_2.ContextForIntent, clientIdentity: OpenFin_2.ClientIdentity & {
5561
+ entityType: OpenFin_2.EntityType;
5562
+ }): Promise<unknown>;
5580
5563
  /**
5581
5564
  * Provides the identity of any Interop Client that disconnects from the Interop Broker. It is meant to be overriden.
5582
5565
  * @param clientIdentity
@@ -5610,7 +5593,7 @@ declare class InteropBroker extends Base {
5610
5593
  /**
5611
5594
  * Responsible for resolving the fdc3.findInstances call.
5612
5595
  * Must be overridden
5613
- * @param app AppIdentifier that was passed to fdc3.findInstances
5596
+ * @param app AppIdentifier that was passed to fdc3.findInstances
5614
5597
  * @param clientIdentity Identity of the Client making the request.
5615
5598
  */
5616
5599
  fdc3HandleFindInstances(app: AppIdentifier, clientIdentity: OpenFin_2.ClientIdentity): Promise<unknown>;
@@ -5635,7 +5618,7 @@ declare class InteropBroker extends Base {
5635
5618
  * fin.Platform.init({
5636
5619
  * interopOverride: async (InteropBroker) => {
5637
5620
  * class Override extends InteropBroker {
5638
- * async invokeContextHandler(options, clientIdentity) {
5621
+ * async invokeContextHandler(clientIdentity, handlerId, context) {
5639
5622
  * return super.invokeContextHandler(clientIdentity, handlerId, {
5640
5623
  * ...context,
5641
5624
  * contextMetadata: {
@@ -5667,7 +5650,7 @@ declare class InteropBroker extends Base {
5667
5650
  * fin.Platform.init({
5668
5651
  * interopOverride: async (InteropBroker) => {
5669
5652
  * class Override extends InteropBroker {
5670
- * async invokeIntentHandler(options, clientIdentity) {
5653
+ * async invokeIntentHandler(clientIdentity, handlerId, context) {
5671
5654
  * const { context } = intent;
5672
5655
  * return super.invokeIntentHandler(clientIdentity, handlerId, {
5673
5656
  * ...intent,
@@ -6349,7 +6332,6 @@ declare class InteropModule extends Base {
6349
6332
  * const contextGroups = await interopBroker.getContextGroups();
6350
6333
  * console.log(contextGroups);
6351
6334
  * ```
6352
- * @static
6353
6335
  */
6354
6336
  init(name: string, override?: OpenFin_2.OverrideCallback<InteropBroker> | OpenFin_2.ConstructorOverride<InteropBroker>[]): Promise<InteropBroker>;
6355
6337
  /**
@@ -6371,7 +6353,6 @@ declare class InteropModule extends Base {
6371
6353
  * const contextGroupInfo = await client.getInfoForContextGroup();
6372
6354
  * console.log(contextGroupInfo);
6373
6355
  * ```
6374
- * @static
6375
6356
  */
6376
6357
  connectSync(name: string, interopConfig?: OpenFin_2.InteropConfig): InteropClient;
6377
6358
  }
@@ -6925,7 +6906,6 @@ declare class LayoutModule extends Base {
6925
6906
  #private;
6926
6907
  /**
6927
6908
  * Asynchronously returns a Layout object that represents a Window's layout.
6928
- * @param identity
6929
6909
  *
6930
6910
  * @example
6931
6911
  * ```js
@@ -6942,12 +6922,10 @@ declare class LayoutModule extends Base {
6942
6922
  * // Use wrapped instance to control layout, e.g.:
6943
6923
  * const layoutConfig = await layout.getConfig();
6944
6924
  * ```
6945
- * @static
6946
6925
  */
6947
6926
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Layout>;
6948
6927
  /**
6949
6928
  * Synchronously returns a Layout object that represents a Window's layout.
6950
- * @param identity
6951
6929
  *
6952
6930
  * @example
6953
6931
  * ```js
@@ -6964,7 +6942,6 @@ declare class LayoutModule extends Base {
6964
6942
  * // Use wrapped instance to control layout, e.g.:
6965
6943
  * const layoutConfig = await layout.getConfig();
6966
6944
  * ```
6967
- * @static
6968
6945
  */
6969
6946
  wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Layout;
6970
6947
  /**
@@ -6976,7 +6953,6 @@ declare class LayoutModule extends Base {
6976
6953
  * // Use wrapped instance to control layout, e.g.:
6977
6954
  * const layoutConfig = await layout.getConfig();
6978
6955
  * ```
6979
- * @static
6980
6956
  */
6981
6957
  getCurrent(): Promise<OpenFin_2.Layout>;
6982
6958
  /**
@@ -6991,7 +6967,6 @@ declare class LayoutModule extends Base {
6991
6967
  * // Use wrapped instance to control layout, e.g.:
6992
6968
  * const layoutConfig = await layout.getConfig();
6993
6969
  * ```
6994
- * @static
6995
6970
  */
6996
6971
  getCurrentSync(): OpenFin_2.Layout;
6997
6972
  /**
@@ -7031,7 +7006,6 @@ declare class LayoutModule extends Base {
7031
7006
  * // the window must have been created with a layout in its window options
7032
7007
  * const layout = await fin.Platform.Layout.init({ containerId });
7033
7008
  * ```
7034
- * @static
7035
7009
  */
7036
7010
  init: (options?: InitLayoutOptions) => Promise<OpenFin_2.Layout>;
7037
7011
  }
@@ -8055,7 +8029,7 @@ declare namespace OpenFin_2 {
8055
8029
  AutoResizeOptions,
8056
8030
  InteropConfig,
8057
8031
  ViewInfo,
8058
- UpdatableViewOptions_2 as UpdatableViewOptions,
8032
+ UpdatableViewOptions,
8059
8033
  ViewCreationOptions,
8060
8034
  MutableViewOptions,
8061
8035
  ViewOptions,
@@ -8250,7 +8224,7 @@ declare namespace OpenFin_2 {
8250
8224
  WindowEvents,
8251
8225
  ViewEvents,
8252
8226
  GlobalHotkeyEvents,
8253
- FrameEvents_2 as FrameEvents,
8227
+ FrameEvents,
8254
8228
  PlatformEvents,
8255
8229
  ExternalApplicationEvents,
8256
8230
  BaseEvent_2 as BaseEvent,
@@ -8259,7 +8233,7 @@ declare namespace OpenFin_2 {
8259
8233
  SystemEvent_2 as SystemEvent,
8260
8234
  ApplicationEvent_2 as ApplicationEvent,
8261
8235
  WindowEvent_2 as WindowEvent,
8262
- ViewEvent_3 as ViewEvent,
8236
+ ViewEvent_2 as ViewEvent,
8263
8237
  GlobalHotkeyEvent_2 as GlobalHotkeyEvent,
8264
8238
  FrameEvent_2 as FrameEvent,
8265
8239
  PlatformEvent_2 as PlatformEvent,
@@ -9052,12 +9026,10 @@ declare class PlatformModule extends Base {
9052
9026
  * fin.Platform.init({overrideCallback});
9053
9027
  * ```
9054
9028
  * @experimental
9055
- * @static
9056
9029
  */
9057
9030
  init(options?: OpenFin_2.InitPlatformOptions): Promise<void>;
9058
9031
  /**
9059
9032
  * Asynchronously returns a Platform object that represents an existing platform.
9060
- * @param identity
9061
9033
  *
9062
9034
  * @example
9063
9035
  * ```js
@@ -9066,12 +9038,10 @@ declare class PlatformModule extends Base {
9066
9038
  * // Use wrapped instance to control layout, e.g.:
9067
9039
  * const snapshot = await platform.getSnapshot();
9068
9040
  * ```
9069
- * @static
9070
9041
  */
9071
9042
  wrap(identity: OpenFin_2.ApplicationIdentity): Promise<OpenFin_2.Platform>;
9072
9043
  /**
9073
9044
  * Synchronously returns a Platform object that represents an existing platform.
9074
- * @param identity
9075
9045
  *
9076
9046
  * @example
9077
9047
  * ```js
@@ -9080,7 +9050,6 @@ declare class PlatformModule extends Base {
9080
9050
  * // Use wrapped instance to control layout, e.g.:
9081
9051
  * const snapshot = await platform.getSnapshot();
9082
9052
  * ```
9083
- * @static
9084
9053
  */
9085
9054
  wrapSync(identity: OpenFin_2.ApplicationIdentity): OpenFin_2.Platform;
9086
9055
  /**
@@ -9092,7 +9061,6 @@ declare class PlatformModule extends Base {
9092
9061
  * // Use wrapped instance to control layout, e.g.:
9093
9062
  * const snapshot = await platform.getSnapshot();
9094
9063
  * ```
9095
- * @static
9096
9064
  */
9097
9065
  getCurrent(): Promise<OpenFin_2.Platform>;
9098
9066
  /**
@@ -9104,13 +9072,11 @@ declare class PlatformModule extends Base {
9104
9072
  * // Use wrapped instance to control layout, e.g.:
9105
9073
  * const snapshot = await platform.getSnapshot();
9106
9074
  * ```
9107
- * @static
9108
9075
  */
9109
9076
  getCurrentSync(): OpenFin_2.Platform;
9110
9077
  /**
9111
9078
  * Creates and starts a Platform and returns a wrapped and running Platform instance. The wrapped Platform methods can
9112
9079
  * be used to launch content into the platform. Promise will reject if the platform is already running.
9113
- * @param platformOptions
9114
9080
  *
9115
9081
  * @example
9116
9082
  * ```js
@@ -9131,7 +9097,6 @@ declare class PlatformModule extends Base {
9131
9097
  * console.error(e);
9132
9098
  * }
9133
9099
  * ```
9134
- * @static
9135
9100
  */
9136
9101
  start(platformOptions: OpenFin_2.PlatformOptions): Promise<OpenFin_2.Platform>;
9137
9102
  /**
@@ -9156,7 +9121,6 @@ declare class PlatformModule extends Base {
9156
9121
  * console.error(e);
9157
9122
  * }
9158
9123
  * ```
9159
- * @static
9160
9124
  */
9161
9125
  startFromManifest(manifestUrl: string, opts?: OpenFin_2.RvmLaunchOptions): Promise<OpenFin_2.Platform>;
9162
9126
  }
@@ -10887,7 +10851,6 @@ declare class SnapshotSource<T = any> extends Base {
10887
10851
  declare class SnapshotSourceModule extends Base {
10888
10852
  /**
10889
10853
  * Initializes a SnapshotSource with the getSnapshot and applySnapshot methods defined.
10890
- * @param provider
10891
10854
  *
10892
10855
  * @example
10893
10856
  * ```js
@@ -10904,12 +10867,10 @@ declare class SnapshotSourceModule extends Base {
10904
10867
  *
10905
10868
  * await fin.SnapshotSource.init(snapshotProvider);
10906
10869
  * ```
10907
- * @static
10908
10870
  */
10909
10871
  init<T = any>(provider: OpenFin_2.SnapshotProvider<T>): Promise<void>;
10910
10872
  /**
10911
10873
  * Synchronously returns a SnapshotSource object that represents the current SnapshotSource.
10912
- * @param identity
10913
10874
  *
10914
10875
  * @example
10915
10876
  * ```js
@@ -10917,12 +10878,10 @@ declare class SnapshotSourceModule extends Base {
10917
10878
  * // Use wrapped instance's getSnapshot method, e.g.:
10918
10879
  * const snapshot = await snapshotSource.getSnapshot();
10919
10880
  * ```
10920
- * @static
10921
10881
  */
10922
10882
  wrapSync(identity: OpenFin_2.ApplicationIdentity): SnapshotSource;
10923
10883
  /**
10924
10884
  * Asynchronously returns a SnapshotSource object that represents the current SnapshotSource.
10925
- * @param identity
10926
10885
  *
10927
10886
  * @example
10928
10887
  * ```js
@@ -10930,7 +10889,6 @@ declare class SnapshotSourceModule extends Base {
10930
10889
  * // Use wrapped instance's getSnapshot method, e.g.:
10931
10890
  * const snapshot = await snapshotSource.getSnapshot();
10932
10891
  * ```
10933
- * @static
10934
10892
  */
10935
10893
  wrap(identity: OpenFin_2.ApplicationIdentity): Promise<SnapshotSource>;
10936
10894
  }
@@ -11209,7 +11167,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
11209
11167
  * ```js
11210
11168
  * fin.System.getUniqueUserId().then(id => console.log(id)).catch(err => console.log(err));
11211
11169
  * ```
11212
- * @static
11213
11170
  */
11214
11171
  getUniqueUserId(): Promise<string>;
11215
11172
  /**
@@ -12246,7 +12203,6 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
12246
12203
  * }
12247
12204
  * });
12248
12205
  * ```
12249
- * @static
12250
12206
  */
12251
12207
  launchManifest(manifestUrl: string, opts?: OpenFin_2.RvmLaunchOptions): Promise<OpenFin_2.Manifest>;
12252
12208
  /**
@@ -12942,12 +12898,10 @@ declare type UnregisteredEvent = BaseEvent & {
12942
12898
  type: 'unregistered';
12943
12899
  };
12944
12900
 
12945
- declare type UpdatableViewOptions = OpenFin_2.UpdatableViewOptions;
12946
-
12947
12901
  /**
12948
12902
  * View options that can be updated after creation.
12949
12903
  */
12950
- declare type UpdatableViewOptions_2 = Partial<MutableViewOptions>;
12904
+ declare type UpdatableViewOptions = Partial<MutableViewOptions>;
12951
12905
 
12952
12906
  declare type UpdatableWindowOptions = Partial<MutableWindowOptions>;
12953
12907
 
@@ -13164,7 +13118,7 @@ declare type View = OpenFin_2.View;
13164
13118
  *
13165
13119
  * 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.
13166
13120
  */
13167
- declare class View_2 extends WebContents<ViewEvent> {
13121
+ declare class View_2 extends WebContents<OpenFin_2.ViewEvent> {
13168
13122
  #private;
13169
13123
  identity: OpenFin_2.Identity;
13170
13124
  /**
@@ -13174,10 +13128,6 @@ declare class View_2 extends WebContents<ViewEvent> {
13174
13128
  /**
13175
13129
  * Focuses the view
13176
13130
  *
13177
- * @function focus
13178
- * @memberof View
13179
- * @emits focused
13180
- * @instance
13181
13131
  * @example
13182
13132
  * ```js
13183
13133
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -13461,7 +13411,6 @@ declare class View_2 extends WebContents<ViewEvent> {
13461
13411
  getOptions: () => Promise<OpenFin_2.ViewOptions>;
13462
13412
  /**
13463
13413
  * Updates the view's options.
13464
- * @param options
13465
13414
  *
13466
13415
  * @example
13467
13416
  * ```js
@@ -13496,11 +13445,10 @@ declare class View_2 extends WebContents<ViewEvent> {
13496
13445
  * ```
13497
13446
  * @experimental
13498
13447
  */
13499
- updateOptions: (options: UpdatableViewOptions) => Promise<void>;
13448
+ updateOptions: (options: OpenFin_2.UpdatableViewOptions) => Promise<void>;
13500
13449
  /**
13501
13450
  * Retrieves the window the view is currently attached to.
13502
13451
  *
13503
- * @experimental
13504
13452
  * @example
13505
13453
  * ```js
13506
13454
  * const view = fin.View.wrapSync({ uuid: 'viewUuid', name: 'viewName' });
@@ -13508,6 +13456,7 @@ declare class View_2 extends WebContents<ViewEvent> {
13508
13456
  * .then(win => console.log('current window', win))
13509
13457
  * .catch(err => console.log(err));)
13510
13458
  * ```
13459
+ * @experimental
13511
13460
  */
13512
13461
  getCurrentWindow: () => Promise<OpenFin_2.Window>;
13513
13462
  /**
@@ -13616,16 +13565,14 @@ declare type ViewDetachedEvent = NamedEvent & BaseViewEvent & {
13616
13565
  previousTarget: OpenFin_2.Identity;
13617
13566
  };
13618
13567
 
13619
- declare type ViewEvent = OpenFin_2.ViewEvent;
13620
-
13621
13568
  /**
13622
13569
  * A View event.
13623
13570
  */
13624
- declare type ViewEvent_2 = {
13571
+ declare type ViewEvent = {
13625
13572
  topic: 'view';
13626
13573
  } & (NonPropagatedViewEvent | WillPropagateViewEvent);
13627
13574
 
13628
- declare type ViewEvent_3 = ViewEvents.ViewEvent;
13575
+ declare type ViewEvent_2 = ViewEvents.ViewEvent;
13629
13576
 
13630
13577
  declare namespace ViewEvents {
13631
13578
  export {
@@ -13639,7 +13586,7 @@ declare namespace ViewEvents {
13639
13586
  HotkeyEvent,
13640
13587
  ShownEvent,
13641
13588
  WillPropagateViewEvent,
13642
- ViewEvent_2 as ViewEvent,
13589
+ ViewEvent,
13643
13590
  ViewEventType,
13644
13591
  PropagatedViewEvent,
13645
13592
  PropagatedViewEventType
@@ -13649,7 +13596,7 @@ declare namespace ViewEvents {
13649
13596
  /**
13650
13597
  * A View event type.
13651
13598
  */
13652
- declare type ViewEventType = ViewEvent_2['type'];
13599
+ declare type ViewEventType = ViewEvent['type'];
13653
13600
 
13654
13601
  declare type ViewInfo = {
13655
13602
  canNavigateBack: boolean;
@@ -13688,12 +13635,10 @@ declare class ViewModule extends Base {
13688
13635
  * ```
13689
13636
  * Note that created views needs to navigate somewhere for them to actually render a website.
13690
13637
  * @experimental
13691
- * @static
13692
13638
  */
13693
13639
  create(options: OpenFin_2.ViewCreationOptions): Promise<OpenFin_2.View>;
13694
13640
  /**
13695
13641
  * Asynchronously returns a View object that represents an existing view.
13696
- * @param identity
13697
13642
  *
13698
13643
  * @example
13699
13644
  * ```js
@@ -13702,12 +13647,10 @@ declare class ViewModule extends Base {
13702
13647
  * .catch(err => console.log(err));
13703
13648
  * ```
13704
13649
  * @experimental
13705
- * @static
13706
13650
  */
13707
13651
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.View>;
13708
13652
  /**
13709
13653
  * Synchronously returns a View object that represents an existing view.
13710
- * @param identity
13711
13654
  *
13712
13655
  * @example
13713
13656
  * ```js
@@ -13715,7 +13658,6 @@ declare class ViewModule extends Base {
13715
13658
  * await view.hide();
13716
13659
  * ```
13717
13660
  * @experimental
13718
- * @static
13719
13661
  */
13720
13662
  wrapSync(identity: OpenFin_2.Identity): OpenFin_2.View;
13721
13663
  /**
@@ -13729,7 +13671,6 @@ declare class ViewModule extends Base {
13729
13671
  *
13730
13672
  * ```
13731
13673
  * @experimental
13732
- * @static
13733
13674
  */
13734
13675
  getCurrent(): Promise<OpenFin_2.View>;
13735
13676
  /**
@@ -13742,7 +13683,6 @@ declare class ViewModule extends Base {
13742
13683
  *
13743
13684
  * ```
13744
13685
  * @experimental
13745
- * @static
13746
13686
  */
13747
13687
  getCurrentSync(): OpenFin_2.View;
13748
13688
  }
@@ -13862,10 +13802,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13862
13802
  constructor(wire: Transport, identity: OpenFin_2.Identity, entityType: string);
13863
13803
  /**
13864
13804
  * Gets a base64 encoded image of all or part of the WebContents.
13865
- * @function capturePage
13866
13805
  * @param options Options for the capturePage call.
13867
- * @memberOf View
13868
- * @instance
13869
13806
  *
13870
13807
  * @example
13871
13808
  *
@@ -13916,9 +13853,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13916
13853
  * Executes Javascript on the WebContents, restricted to contents you own or contents owned by
13917
13854
  * applications you have created.
13918
13855
  * @param code JavaScript code to be executed on the view.
13919
- * @function executeJavaScript
13920
- * @memberOf View
13921
- * @instance
13922
13856
  *
13923
13857
  * @example
13924
13858
  * View:
@@ -13950,9 +13884,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13950
13884
  executeJavaScript(code: string): Promise<void>;
13951
13885
  /**
13952
13886
  * Returns the zoom level of the WebContents.
13953
- * @function getZoomLevel
13954
- * @memberOf View
13955
- * @instance
13956
13887
  *
13957
13888
  * @example
13958
13889
  * View:
@@ -13989,9 +13920,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
13989
13920
  /**
13990
13921
  * Sets the zoom level of the WebContents.
13991
13922
  * @param level The zoom level
13992
- * @function setZoomLevel
13993
- * @memberOf View
13994
- * @instance
13995
13923
  *
13996
13924
  * @example
13997
13925
  * View:
@@ -14031,9 +13959,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14031
13959
  * @remarks The url must contain the protocol prefix such as http:// or https://.
14032
13960
  * @param url - The URL to navigate the WebContents to.
14033
13961
  *
14034
- * @function navigate
14035
- * @memberof View
14036
- * @instance
14037
13962
  * @example
14038
13963
  * View:
14039
13964
  * ```js
@@ -14065,9 +13990,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14065
13990
  navigate(url: string): Promise<void>;
14066
13991
  /**
14067
13992
  * Navigates the WebContents back one page.
14068
- * @function navigateBack
14069
- * @memberOf View
14070
- * @instance
14071
13993
  *
14072
13994
  * @example
14073
13995
  * View:
@@ -14093,9 +14015,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14093
14015
  navigateBack(): Promise<void>;
14094
14016
  /**
14095
14017
  * Navigates the WebContents forward one page.
14096
- * @function navigateForward
14097
- * @memberOf View
14098
- * @instance
14099
14018
  *
14100
14019
  * @example
14101
14020
  * View:
@@ -14123,9 +14042,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14123
14042
  navigateForward(): Promise<void>;
14124
14043
  /**
14125
14044
  * Stops any current navigation the WebContents is performing.
14126
- * @function stopNavigation
14127
- * @memberOf View
14128
- * @instance
14129
14045
  *
14130
14046
  * @example
14131
14047
  * View:
@@ -14151,9 +14067,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14151
14067
  stopNavigation(): Promise<void>;
14152
14068
  /**
14153
14069
  * Reloads the WebContents
14154
- * @function reload
14155
- * @memberOf View
14156
- * @instance
14157
14070
  *
14158
14071
  * @example
14159
14072
  * View:
@@ -14190,9 +14103,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14190
14103
  /**
14191
14104
  * Prints the WebContents.
14192
14105
  * @param options Printer Options
14193
- * @function print
14194
- * @memberOf View
14195
- * @instance
14196
14106
  *
14197
14107
  * @remarks When `silent` is set to `true`, the API will pick the system's default printer if deviceName
14198
14108
  * is empty and the default settings for printing.
@@ -14213,9 +14123,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14213
14123
  * Find and highlight text on a page.
14214
14124
  * @param searchTerm Term to find in page
14215
14125
  * @param options Search options
14216
- * @function findInPage
14217
- * @memberOf View
14218
- * @instance
14219
14126
  *
14220
14127
  * @remarks By default, each subsequent call will highlight the next text that matches the search term.
14221
14128
  *
@@ -14296,9 +14203,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14296
14203
  /**
14297
14204
  * Returns an array with all system printers
14298
14205
  * @deprecated use System.getPrinters instead
14299
- * @function getPrinters
14300
- * @memberOf View
14301
- * @instance
14302
14206
  *
14303
14207
  * @example
14304
14208
  * View:
@@ -14339,10 +14243,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14339
14243
  /**
14340
14244
  * Gives focus to the WebContents.
14341
14245
  *
14342
- * @function focus
14343
- * @emits focused
14344
- * @memberOf Window
14345
- * @instance
14346
14246
  * @example
14347
14247
  * ```js
14348
14248
  * async function focusWindow() {
@@ -14364,9 +14264,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14364
14264
  }): Promise<void>;
14365
14265
  /**
14366
14266
  * Shows the Chromium Developer Tools
14367
- * @function showDeveloperTools
14368
- * @memberOf View
14369
- * @instance
14370
14267
  *
14371
14268
  * @example
14372
14269
  * View:
@@ -14399,10 +14296,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14399
14296
  *
14400
14297
  * @remarks This includes any iframes associated with the WebContents
14401
14298
  *
14402
- * @function getProcessInfo
14403
- * @memberOf View
14404
- * @instance
14405
- *
14406
14299
  * @example
14407
14300
  * View:
14408
14301
  * ```js
@@ -14419,9 +14312,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14419
14312
  getProcessInfo(): Promise<OpenFin_2.EntityProcessDetails>;
14420
14313
  /**
14421
14314
  * Retrieves information on all Shared Workers.
14422
- * @function getSharedWorkers
14423
- * @memberOf View
14424
- * @instance
14425
14315
  *
14426
14316
  * @example
14427
14317
  * View:
@@ -14454,9 +14344,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14454
14344
  getSharedWorkers(): Promise<OpenFin_2.SharedWorkerInfo[]>;
14455
14345
  /**
14456
14346
  * Opens the developer tools for the shared worker context.
14457
- * @function inspectSharedWorker
14458
- * @memberOf View
14459
- * @instance
14460
14347
  *
14461
14348
  * @example
14462
14349
  * View:
@@ -14490,9 +14377,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14490
14377
  /**
14491
14378
  * Inspects the shared worker based on its ID.
14492
14379
  * @param workerId - The id of the shared worker.
14493
- * @function inspectSharedWorkerById
14494
- * @memberOf View
14495
- * @instance
14496
14380
  *
14497
14381
  * @example
14498
14382
  * View:
@@ -14527,9 +14411,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14527
14411
  inspectSharedWorkerById(workerId: string): Promise<void>;
14528
14412
  /**
14529
14413
  * Opens the developer tools for the service worker context.
14530
- * @function inspectServiceWorker
14531
- * @memberOf View
14532
- * @instance
14533
14414
  *
14534
14415
  * @example
14535
14416
  * View:
@@ -14766,11 +14647,6 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
14766
14647
  * onPopupReady: popupWindowCallback;
14767
14648
  * });
14768
14649
  * ```
14769
- * @function showPopupWindow
14770
- * @memberOf View
14771
- * @instance
14772
- * @param options
14773
- *
14774
14650
  */
14775
14651
  showPopupWindow(options: OpenFin_2.PopupOptions): Promise<OpenFin_2.PopupResult>;
14776
14652
  }
@@ -16689,7 +16565,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16689
16565
  declare class _WindowModule extends Base {
16690
16566
  /**
16691
16567
  * Asynchronously returns a Window object that represents an existing window.
16692
- * @param identity
16693
16568
  *
16694
16569
  * @example
16695
16570
  * ```js
@@ -16706,12 +16581,10 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16706
16581
  * .then(win => console.log('wrapped window'))
16707
16582
  * .catch(err => console.log(err));
16708
16583
  * ```
16709
- * @static
16710
16584
  */
16711
16585
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
16712
16586
  /**
16713
16587
  * Synchronously returns a Window object that represents an existing window.
16714
- * @param identity
16715
16588
  *
16716
16589
  * @example
16717
16590
  * ```js
@@ -16727,7 +16600,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16727
16600
  * await createWin();
16728
16601
  * let win = fin.Window.wrapSync({ uuid: 'app-1', name: 'myApp' });
16729
16602
  * ```
16730
- * @static
16731
16603
  */
16732
16604
  wrapSync(identity: OpenFin_2.Identity): OpenFin_2.Window;
16733
16605
  /**
@@ -16750,7 +16622,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16750
16622
  *
16751
16623
  * createWindow().then(() => console.log('Window is created')).catch(err => console.log(err));
16752
16624
  * ```
16753
- * @static
16754
16625
  */
16755
16626
  create(options: OpenFin_2.WindowCreationOptions): Promise<OpenFin_2.Window>;
16756
16627
  /**
@@ -16763,7 +16634,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16763
16634
  * .catch(err => console.log(err));
16764
16635
  *
16765
16636
  * ```
16766
- * @static
16767
16637
  */
16768
16638
  getCurrent(): Promise<OpenFin_2.Window>;
16769
16639
  /**
@@ -16776,7 +16646,6 @@ declare class _Window extends WebContents<OpenFin_2.WindowEvent> {
16776
16646
  * console.log(info);
16777
16647
  *
16778
16648
  * ```
16779
- * @static
16780
16649
  */
16781
16650
  getCurrentSync(): OpenFin_2.Window;
16782
16651
  }