@openfin/fdc3-api 37.80.25 → 37.80.34

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.
@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
966
966
  * @interface
967
967
  */
968
968
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
969
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
970
  launchMode: string;
971
971
  manifest: Manifest & {
972
972
  [key: string]: any;
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
983
983
  */
984
984
  declare class ApplicationModule extends Base {
985
985
  /**
986
- * Asynchronously returns an Application object that represents an existing application.
986
+ * Asynchronously returns an API handle for the given Application identity.
987
+ *
988
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
989
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
990
+ * for an Application throughout its entire lifecycle.
987
991
  *
988
992
  * @example
989
993
  *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
997
1001
  */
998
1002
  wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
999
1003
  /**
1000
- * Synchronously returns an Application object that represents an existing application.
1004
+ * Synchronously returns an API handle for the given Application identity.
1005
+ *
1006
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
1007
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
1008
+ * for an Aplication throughout its entire lifecycle.
1001
1009
  *
1002
1010
  * @example
1003
1011
  *
@@ -3808,7 +3816,7 @@ declare type ConstWindowOptions = {
3808
3816
  */
3809
3817
  viewVisibility?: ViewVisibilityOptions;
3810
3818
  /**
3811
- * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
3819
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3812
3820
  */
3813
3821
  inheritance?: Partial<InheritableOptions>;
3814
3822
  };
@@ -6193,6 +6201,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6193
6201
  * Returns a frame info object representing the window that the referenced iframe is
6194
6202
  * currently embedded in.
6195
6203
  *
6204
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6205
+ *
6196
6206
  * @example
6197
6207
  * ```js
6198
6208
  * async function getParentWindow() {
@@ -6260,8 +6270,11 @@ declare type FrameInfo = {
6260
6270
  */
6261
6271
  declare class _FrameModule extends Base {
6262
6272
  /**
6263
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
6264
- * @param identity - the identity of the frame you want to wrap
6273
+ * Asynchronously returns an API handle for the given Frame identity.
6274
+ *
6275
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6276
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6277
+ * for a Frame throughout its entire lifecycle.
6265
6278
  *
6266
6279
  * @example
6267
6280
  * ```js
@@ -6272,8 +6285,11 @@ declare class _FrameModule extends Base {
6272
6285
  */
6273
6286
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
6274
6287
  /**
6275
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
6276
- * @param identity - the identity of the frame you want to wrap
6288
+ * Synchronously returns an API handle for the given Frame identity.
6289
+ *
6290
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6291
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6292
+ * for a Frame throughout its entire lifecycle.
6277
6293
  *
6278
6294
  * @example
6279
6295
  * ```js
@@ -6331,14 +6347,6 @@ declare type GetLogRequestType_2 = {
6331
6347
  * The name of the running application
6332
6348
  */
6333
6349
  name: string;
6334
- /**
6335
- * The file length of the log file
6336
- */
6337
- endFile?: string;
6338
- /**
6339
- * The size limit of the log file.
6340
- */
6341
- sizeLimit?: number;
6342
6350
  };
6343
6351
 
6344
6352
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8646,6 +8654,7 @@ declare type LaunchExternalProcessRule = {
8646
8654
  */
8647
8655
  declare type LaunchIntoPlatformPayload = {
8648
8656
  manifest: any;
8657
+ manifestUrl?: string;
8649
8658
  };
8650
8659
 
8651
8660
  /**
@@ -11493,6 +11502,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11493
11502
  * The provider url.
11494
11503
  */
11495
11504
  providerUrl?: string;
11505
+ /**
11506
+ * @defaultValue true
11507
+ *
11508
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11509
+ *
11510
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11511
+ */
11512
+ allowLaunchIntoPlatform?: boolean;
11496
11513
  };
11497
11514
 
11498
11515
  /**
@@ -16418,7 +16435,11 @@ declare class ViewModule extends Base {
16418
16435
  */
16419
16436
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16420
16437
  /**
16421
- * Asynchronously returns a View object that represents an existing view.
16438
+ * Asynchronously returns an API handle for the given View identity.
16439
+ *
16440
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16441
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16442
+ * for a View throughout its entire lifecycle.
16422
16443
  *
16423
16444
  * @example
16424
16445
  * ```js
@@ -16430,7 +16451,11 @@ declare class ViewModule extends Base {
16430
16451
  */
16431
16452
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16432
16453
  /**
16433
- * Synchronously returns a View object that represents an existing view.
16454
+ * Synchronously returns an API handle for the given View identity.
16455
+ *
16456
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16457
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16458
+ * for a View throughout its entire lifecycle.
16434
16459
  *
16435
16460
  * @example
16436
16461
  * ```js
@@ -18878,7 +18903,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18878
18903
  */
18879
18904
  declare class _WindowModule extends Base {
18880
18905
  /**
18881
- * Asynchronously returns a Window object that represents an existing window.
18906
+ * Asynchronously returns an API handle for the given Window identity.
18907
+ *
18908
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18909
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18910
+ * for a Window throughout its entire lifecycle.
18882
18911
  *
18883
18912
  * @example
18884
18913
  * ```js
@@ -18898,7 +18927,11 @@ declare class _WindowModule extends Base {
18898
18927
  */
18899
18928
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18900
18929
  /**
18901
- * Synchronously returns a Window object that represents an existing window.
18930
+ * Synchronously returns an API handle for the given Window identity.
18931
+ *
18932
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18933
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18934
+ * for a Window throughout its entire lifecycle.
18902
18935
  *
18903
18936
  * @example
18904
18937
  * ```js
@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
966
966
  * @interface
967
967
  */
968
968
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
969
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
970
  launchMode: string;
971
971
  manifest: Manifest & {
972
972
  [key: string]: any;
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
983
983
  */
984
984
  declare class ApplicationModule extends Base {
985
985
  /**
986
- * Asynchronously returns an Application object that represents an existing application.
986
+ * Asynchronously returns an API handle for the given Application identity.
987
+ *
988
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
989
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
990
+ * for an Application throughout its entire lifecycle.
987
991
  *
988
992
  * @example
989
993
  *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
997
1001
  */
998
1002
  wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
999
1003
  /**
1000
- * Synchronously returns an Application object that represents an existing application.
1004
+ * Synchronously returns an API handle for the given Application identity.
1005
+ *
1006
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
1007
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
1008
+ * for an Aplication throughout its entire lifecycle.
1001
1009
  *
1002
1010
  * @example
1003
1011
  *
@@ -3808,7 +3816,7 @@ declare type ConstWindowOptions = {
3808
3816
  */
3809
3817
  viewVisibility?: ViewVisibilityOptions;
3810
3818
  /**
3811
- * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
3819
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3812
3820
  */
3813
3821
  inheritance?: Partial<InheritableOptions>;
3814
3822
  };
@@ -6193,6 +6201,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6193
6201
  * Returns a frame info object representing the window that the referenced iframe is
6194
6202
  * currently embedded in.
6195
6203
  *
6204
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6205
+ *
6196
6206
  * @example
6197
6207
  * ```js
6198
6208
  * async function getParentWindow() {
@@ -6260,8 +6270,11 @@ declare type FrameInfo = {
6260
6270
  */
6261
6271
  declare class _FrameModule extends Base {
6262
6272
  /**
6263
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
6264
- * @param identity - the identity of the frame you want to wrap
6273
+ * Asynchronously returns an API handle for the given Frame identity.
6274
+ *
6275
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6276
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6277
+ * for a Frame throughout its entire lifecycle.
6265
6278
  *
6266
6279
  * @example
6267
6280
  * ```js
@@ -6272,8 +6285,11 @@ declare class _FrameModule extends Base {
6272
6285
  */
6273
6286
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
6274
6287
  /**
6275
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
6276
- * @param identity - the identity of the frame you want to wrap
6288
+ * Synchronously returns an API handle for the given Frame identity.
6289
+ *
6290
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6291
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6292
+ * for a Frame throughout its entire lifecycle.
6277
6293
  *
6278
6294
  * @example
6279
6295
  * ```js
@@ -6331,14 +6347,6 @@ declare type GetLogRequestType_2 = {
6331
6347
  * The name of the running application
6332
6348
  */
6333
6349
  name: string;
6334
- /**
6335
- * The file length of the log file
6336
- */
6337
- endFile?: string;
6338
- /**
6339
- * The size limit of the log file.
6340
- */
6341
- sizeLimit?: number;
6342
6350
  };
6343
6351
 
6344
6352
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8646,6 +8654,7 @@ declare type LaunchExternalProcessRule = {
8646
8654
  */
8647
8655
  declare type LaunchIntoPlatformPayload = {
8648
8656
  manifest: any;
8657
+ manifestUrl?: string;
8649
8658
  };
8650
8659
 
8651
8660
  /**
@@ -11493,6 +11502,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11493
11502
  * The provider url.
11494
11503
  */
11495
11504
  providerUrl?: string;
11505
+ /**
11506
+ * @defaultValue true
11507
+ *
11508
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11509
+ *
11510
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11511
+ */
11512
+ allowLaunchIntoPlatform?: boolean;
11496
11513
  };
11497
11514
 
11498
11515
  /**
@@ -16418,7 +16435,11 @@ declare class ViewModule extends Base {
16418
16435
  */
16419
16436
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16420
16437
  /**
16421
- * Asynchronously returns a View object that represents an existing view.
16438
+ * Asynchronously returns an API handle for the given View identity.
16439
+ *
16440
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16441
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16442
+ * for a View throughout its entire lifecycle.
16422
16443
  *
16423
16444
  * @example
16424
16445
  * ```js
@@ -16430,7 +16451,11 @@ declare class ViewModule extends Base {
16430
16451
  */
16431
16452
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16432
16453
  /**
16433
- * Synchronously returns a View object that represents an existing view.
16454
+ * Synchronously returns an API handle for the given View identity.
16455
+ *
16456
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16457
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16458
+ * for a View throughout its entire lifecycle.
16434
16459
  *
16435
16460
  * @example
16436
16461
  * ```js
@@ -18878,7 +18903,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18878
18903
  */
18879
18904
  declare class _WindowModule extends Base {
18880
18905
  /**
18881
- * Asynchronously returns a Window object that represents an existing window.
18906
+ * Asynchronously returns an API handle for the given Window identity.
18907
+ *
18908
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18909
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18910
+ * for a Window throughout its entire lifecycle.
18882
18911
  *
18883
18912
  * @example
18884
18913
  * ```js
@@ -18898,7 +18927,11 @@ declare class _WindowModule extends Base {
18898
18927
  */
18899
18928
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18900
18929
  /**
18901
- * Synchronously returns a Window object that represents an existing window.
18930
+ * Synchronously returns an API handle for the given Window identity.
18931
+ *
18932
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18933
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18934
+ * for a Window throughout its entire lifecycle.
18902
18935
  *
18903
18936
  * @example
18904
18937
  * ```js
@@ -966,7 +966,7 @@ declare type ApplicationIdentity_2 = {
966
966
  * @interface
967
967
  */
968
968
  declare type ApplicationInfo = {
969
- initialOptions: ApplicationCreationOptions;
969
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
970
970
  launchMode: string;
971
971
  manifest: Manifest & {
972
972
  [key: string]: any;
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
983
983
  */
984
984
  declare class ApplicationModule extends Base {
985
985
  /**
986
- * Asynchronously returns an Application object that represents an existing application.
986
+ * Asynchronously returns an API handle for the given Application identity.
987
+ *
988
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
989
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
990
+ * for an Application throughout its entire lifecycle.
987
991
  *
988
992
  * @example
989
993
  *
@@ -997,7 +1001,11 @@ declare class ApplicationModule extends Base {
997
1001
  */
998
1002
  wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
999
1003
  /**
1000
- * Synchronously returns an Application object that represents an existing application.
1004
+ * Synchronously returns an API handle for the given Application identity.
1005
+ *
1006
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
1007
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
1008
+ * for an Aplication throughout its entire lifecycle.
1001
1009
  *
1002
1010
  * @example
1003
1011
  *
@@ -3808,7 +3816,7 @@ declare type ConstWindowOptions = {
3808
3816
  */
3809
3817
  viewVisibility?: ViewVisibilityOptions;
3810
3818
  /**
3811
- * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
3819
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3812
3820
  */
3813
3821
  inheritance?: Partial<InheritableOptions>;
3814
3822
  };
@@ -6193,6 +6201,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6193
6201
  * Returns a frame info object representing the window that the referenced iframe is
6194
6202
  * currently embedded in.
6195
6203
  *
6204
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6205
+ *
6196
6206
  * @example
6197
6207
  * ```js
6198
6208
  * async function getParentWindow() {
@@ -6260,8 +6270,11 @@ declare type FrameInfo = {
6260
6270
  */
6261
6271
  declare class _FrameModule extends Base {
6262
6272
  /**
6263
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
6264
- * @param identity - the identity of the frame you want to wrap
6273
+ * Asynchronously returns an API handle for the given Frame identity.
6274
+ *
6275
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6276
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6277
+ * for a Frame throughout its entire lifecycle.
6265
6278
  *
6266
6279
  * @example
6267
6280
  * ```js
@@ -6272,8 +6285,11 @@ declare class _FrameModule extends Base {
6272
6285
  */
6273
6286
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
6274
6287
  /**
6275
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
6276
- * @param identity - the identity of the frame you want to wrap
6288
+ * Synchronously returns an API handle for the given Frame identity.
6289
+ *
6290
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6291
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6292
+ * for a Frame throughout its entire lifecycle.
6277
6293
  *
6278
6294
  * @example
6279
6295
  * ```js
@@ -6331,14 +6347,6 @@ declare type GetLogRequestType_2 = {
6331
6347
  * The name of the running application
6332
6348
  */
6333
6349
  name: string;
6334
- /**
6335
- * The file length of the log file
6336
- */
6337
- endFile?: string;
6338
- /**
6339
- * The size limit of the log file.
6340
- */
6341
- sizeLimit?: number;
6342
6350
  };
6343
6351
 
6344
6352
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8646,6 +8654,7 @@ declare type LaunchExternalProcessRule = {
8646
8654
  */
8647
8655
  declare type LaunchIntoPlatformPayload = {
8648
8656
  manifest: any;
8657
+ manifestUrl?: string;
8649
8658
  };
8650
8659
 
8651
8660
  /**
@@ -11493,6 +11502,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11493
11502
  * The provider url.
11494
11503
  */
11495
11504
  providerUrl?: string;
11505
+ /**
11506
+ * @defaultValue true
11507
+ *
11508
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11509
+ *
11510
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11511
+ */
11512
+ allowLaunchIntoPlatform?: boolean;
11496
11513
  };
11497
11514
 
11498
11515
  /**
@@ -16418,7 +16435,11 @@ declare class ViewModule extends Base {
16418
16435
  */
16419
16436
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16420
16437
  /**
16421
- * Asynchronously returns a View object that represents an existing view.
16438
+ * Asynchronously returns an API handle for the given View identity.
16439
+ *
16440
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16441
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16442
+ * for a View throughout its entire lifecycle.
16422
16443
  *
16423
16444
  * @example
16424
16445
  * ```js
@@ -16430,7 +16451,11 @@ declare class ViewModule extends Base {
16430
16451
  */
16431
16452
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16432
16453
  /**
16433
- * Synchronously returns a View object that represents an existing view.
16454
+ * Synchronously returns an API handle for the given View identity.
16455
+ *
16456
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16457
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16458
+ * for a View throughout its entire lifecycle.
16434
16459
  *
16435
16460
  * @example
16436
16461
  * ```js
@@ -18878,7 +18903,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18878
18903
  */
18879
18904
  declare class _WindowModule extends Base {
18880
18905
  /**
18881
- * Asynchronously returns a Window object that represents an existing window.
18906
+ * Asynchronously returns an API handle for the given Window identity.
18907
+ *
18908
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18909
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18910
+ * for a Window throughout its entire lifecycle.
18882
18911
  *
18883
18912
  * @example
18884
18913
  * ```js
@@ -18898,7 +18927,11 @@ declare class _WindowModule extends Base {
18898
18927
  */
18899
18928
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
18900
18929
  /**
18901
- * Synchronously returns a Window object that represents an existing window.
18930
+ * Synchronously returns an API handle for the given Window identity.
18931
+ *
18932
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18933
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18934
+ * for a Window throughout its entire lifecycle.
18902
18935
  *
18903
18936
  * @example
18904
18937
  * ```js
package/out/fdc3-api.d.ts CHANGED
@@ -972,7 +972,7 @@ declare type ApplicationIdentity_2 = {
972
972
  * @interface
973
973
  */
974
974
  declare type ApplicationInfo = {
975
- initialOptions: ApplicationCreationOptions;
975
+ initialOptions: ApplicationCreationOptions | PlatformOptions;
976
976
  launchMode: string;
977
977
  manifest: Manifest & {
978
978
  [key: string]: any;
@@ -989,7 +989,11 @@ declare type ApplicationInfo = {
989
989
  */
990
990
  declare class ApplicationModule extends Base {
991
991
  /**
992
- * Asynchronously returns an Application object that represents an existing application.
992
+ * Asynchronously returns an API handle for the given Application identity.
993
+ *
994
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
995
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
996
+ * for an Application throughout its entire lifecycle.
993
997
  *
994
998
  * @example
995
999
  *
@@ -1003,7 +1007,11 @@ declare class ApplicationModule extends Base {
1003
1007
  */
1004
1008
  wrap(identity: OpenFin.ApplicationIdentity): Promise<OpenFin.Application>;
1005
1009
  /**
1006
- * Synchronously returns an Application object that represents an existing application.
1010
+ * Synchronously returns an API handle for the given Application identity.
1011
+ *
1012
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
1013
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
1014
+ * for an Aplication throughout its entire lifecycle.
1007
1015
  *
1008
1016
  * @example
1009
1017
  *
@@ -3863,7 +3871,7 @@ declare type ConstWindowOptions = {
3863
3871
  */
3864
3872
  viewVisibility?: ViewVisibilityOptions;
3865
3873
  /**
3866
- * Controls whether an option is inherited from the parent application. Use { <option>: false } to disable a specific <option>. All inheritable properties will be inherited by default if omitted."
3874
+ * Controls whether an option is inherited from the parent application. The option is set as part of the window options for the parent application in either the {@link Manifest.startup_app} or {@link Manifest.platform} properties in the manifest or in {@link ApplicationOptions.mainWindowOptions} when calling {@link Application.ApplicationModule.start Application.start}. Use { [option]: false } to disable a specific [option]. All inheritable properties will be inherited by default if omitted.
3867
3875
  */
3868
3876
  inheritance?: Partial<InheritableOptions>;
3869
3877
  };
@@ -6277,6 +6285,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
6277
6285
  * Returns a frame info object representing the window that the referenced iframe is
6278
6286
  * currently embedded in.
6279
6287
  *
6288
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
6289
+ *
6280
6290
  * @example
6281
6291
  * ```js
6282
6292
  * async function getParentWindow() {
@@ -6344,8 +6354,11 @@ declare type FrameInfo = {
6344
6354
  */
6345
6355
  declare class _FrameModule extends Base {
6346
6356
  /**
6347
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
6348
- * @param identity - the identity of the frame you want to wrap
6357
+ * Asynchronously returns an API handle for the given Frame identity.
6358
+ *
6359
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6360
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6361
+ * for a Frame throughout its entire lifecycle.
6349
6362
  *
6350
6363
  * @example
6351
6364
  * ```js
@@ -6356,8 +6369,11 @@ declare class _FrameModule extends Base {
6356
6369
  */
6357
6370
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
6358
6371
  /**
6359
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
6360
- * @param identity - the identity of the frame you want to wrap
6372
+ * Synchronously returns an API handle for the given Frame identity.
6373
+ *
6374
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6375
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6376
+ * for a Frame throughout its entire lifecycle.
6361
6377
  *
6362
6378
  * @example
6363
6379
  * ```js
@@ -6415,14 +6431,6 @@ declare type GetLogRequestType_2 = {
6415
6431
  * The name of the running application
6416
6432
  */
6417
6433
  name: string;
6418
- /**
6419
- * The file length of the log file
6420
- */
6421
- endFile?: string;
6422
- /**
6423
- * The size limit of the log file.
6424
- */
6425
- sizeLimit?: number;
6426
6434
  };
6427
6435
 
6428
6436
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -8759,6 +8767,7 @@ declare type LaunchExternalProcessRule = {
8759
8767
  */
8760
8768
  declare type LaunchIntoPlatformPayload = {
8761
8769
  manifest: any;
8770
+ manifestUrl?: string;
8762
8771
  };
8763
8772
 
8764
8773
  /**
@@ -11837,6 +11846,14 @@ declare type PlatformOptions = ApplicationCreationOptions & {
11837
11846
  * The provider url.
11838
11847
  */
11839
11848
  providerUrl?: string;
11849
+ /**
11850
+ * @defaultValue true
11851
+ *
11852
+ * Controls whether it is allowed to launch content manifests into the Platform. If omitted, defaults to `true`.
11853
+ *
11854
+ * NOTE: Starting in v38, the default value will change to `false` and content launching must be explicitly opted into.
11855
+ */
11856
+ allowLaunchIntoPlatform?: boolean;
11840
11857
  };
11841
11858
 
11842
11859
  /**
@@ -16857,7 +16874,11 @@ declare class ViewModule extends Base {
16857
16874
  */
16858
16875
  create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
16859
16876
  /**
16860
- * Asynchronously returns a View object that represents an existing view.
16877
+ * Asynchronously returns an API handle for the given View identity.
16878
+ *
16879
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16880
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16881
+ * for a View throughout its entire lifecycle.
16861
16882
  *
16862
16883
  * @example
16863
16884
  * ```js
@@ -16869,7 +16890,11 @@ declare class ViewModule extends Base {
16869
16890
  */
16870
16891
  wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
16871
16892
  /**
16872
- * Synchronously returns a View object that represents an existing view.
16893
+ * Synchronously returns an API handle for the given View identity.
16894
+ *
16895
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16896
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16897
+ * for a View throughout its entire lifecycle.
16873
16898
  *
16874
16899
  * @example
16875
16900
  * ```js
@@ -19324,7 +19349,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
19324
19349
  */
19325
19350
  declare class _WindowModule extends Base {
19326
19351
  /**
19327
- * Asynchronously returns a Window object that represents an existing window.
19352
+ * Asynchronously returns an API handle for the given Window identity.
19353
+ *
19354
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
19355
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
19356
+ * for a Window throughout its entire lifecycle.
19328
19357
  *
19329
19358
  * @example
19330
19359
  * ```js
@@ -19344,7 +19373,11 @@ declare class _WindowModule extends Base {
19344
19373
  */
19345
19374
  wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
19346
19375
  /**
19347
- * Synchronously returns a Window object that represents an existing window.
19376
+ * Synchronously returns an API handle for the given Window identity.
19377
+ *
19378
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
19379
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
19380
+ * for a Window throughout its entire lifecycle.
19348
19381
  *
19349
19382
  * @example
19350
19383
  * ```js
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "37.80.25",
3
+ "version": "37.80.34",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "private": false,