@openfin/core 37.80.25 → 37.80.33

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.
@@ -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_2.ApplicationIdentity): Promise<OpenFin_2.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
  };
@@ -5859,6 +5867,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5859
5867
  * Returns a frame info object representing the window that the referenced iframe is
5860
5868
  * currently embedded in.
5861
5869
  *
5870
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5871
+ *
5862
5872
  * @example
5863
5873
  * ```js
5864
5874
  * async function getParentWindow() {
@@ -5926,8 +5936,11 @@ declare type FrameInfo = {
5926
5936
  */
5927
5937
  declare class _FrameModule extends Base {
5928
5938
  /**
5929
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5930
- * @param identity - the identity of the frame you want to wrap
5939
+ * Asynchronously returns an API handle for the given Frame identity.
5940
+ *
5941
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5942
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5943
+ * for a Frame throughout its entire lifecycle.
5931
5944
  *
5932
5945
  * @example
5933
5946
  * ```js
@@ -5938,8 +5951,11 @@ declare class _FrameModule extends Base {
5938
5951
  */
5939
5952
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Frame>;
5940
5953
  /**
5941
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5942
- * @param identity - the identity of the frame you want to wrap
5954
+ * Synchronously returns an API handle for the given Frame identity.
5955
+ *
5956
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5957
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5958
+ * for a Frame throughout its entire lifecycle.
5943
5959
  *
5944
5960
  * @example
5945
5961
  * ```js
@@ -5997,14 +6013,6 @@ declare type GetLogRequestType_2 = {
5997
6013
  * The name of the running application
5998
6014
  */
5999
6015
  name: string;
6000
- /**
6001
- * The file length of the log file
6002
- */
6003
- endFile?: string;
6004
- /**
6005
- * The size limit of the log file.
6006
- */
6007
- sizeLimit?: number;
6008
6016
  };
6009
6017
 
6010
6018
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -16085,7 +16093,11 @@ declare class ViewModule extends Base {
16085
16093
  */
16086
16094
  create(options: OpenFin_2.ViewCreationOptions): Promise<OpenFin_2.View>;
16087
16095
  /**
16088
- * Asynchronously returns a View object that represents an existing view.
16096
+ * Asynchronously returns an API handle for the given View identity.
16097
+ *
16098
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16099
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16100
+ * for a View throughout its entire lifecycle.
16089
16101
  *
16090
16102
  * @example
16091
16103
  * ```js
@@ -16097,7 +16109,11 @@ declare class ViewModule extends Base {
16097
16109
  */
16098
16110
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.View>;
16099
16111
  /**
16100
- * Synchronously returns a View object that represents an existing view.
16112
+ * Synchronously returns an API handle for the given View identity.
16113
+ *
16114
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16115
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16116
+ * for a View throughout its entire lifecycle.
16101
16117
  *
16102
16118
  * @example
16103
16119
  * ```js
@@ -18545,7 +18561,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18545
18561
  */
18546
18562
  declare class _WindowModule extends Base {
18547
18563
  /**
18548
- * Asynchronously returns a Window object that represents an existing window.
18564
+ * Asynchronously returns an API handle for the given Window identity.
18565
+ *
18566
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18567
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18568
+ * for a Window throughout its entire lifecycle.
18549
18569
  *
18550
18570
  * @example
18551
18571
  * ```js
@@ -18565,7 +18585,11 @@ declare class _WindowModule extends Base {
18565
18585
  */
18566
18586
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
18567
18587
  /**
18568
- * Synchronously returns a Window object that represents an existing window.
18588
+ * Synchronously returns an API handle for the given Window identity.
18589
+ *
18590
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18591
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18592
+ * for a Window throughout its entire lifecycle.
18569
18593
  *
18570
18594
  * @example
18571
18595
  * ```js
@@ -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_2.ApplicationIdentity): Promise<OpenFin_2.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
  };
@@ -5859,6 +5867,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5859
5867
  * Returns a frame info object representing the window that the referenced iframe is
5860
5868
  * currently embedded in.
5861
5869
  *
5870
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5871
+ *
5862
5872
  * @example
5863
5873
  * ```js
5864
5874
  * async function getParentWindow() {
@@ -5926,8 +5936,11 @@ declare type FrameInfo = {
5926
5936
  */
5927
5937
  declare class _FrameModule extends Base {
5928
5938
  /**
5929
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5930
- * @param identity - the identity of the frame you want to wrap
5939
+ * Asynchronously returns an API handle for the given Frame identity.
5940
+ *
5941
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5942
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5943
+ * for a Frame throughout its entire lifecycle.
5931
5944
  *
5932
5945
  * @example
5933
5946
  * ```js
@@ -5938,8 +5951,11 @@ declare class _FrameModule extends Base {
5938
5951
  */
5939
5952
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Frame>;
5940
5953
  /**
5941
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5942
- * @param identity - the identity of the frame you want to wrap
5954
+ * Synchronously returns an API handle for the given Frame identity.
5955
+ *
5956
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5957
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5958
+ * for a Frame throughout its entire lifecycle.
5943
5959
  *
5944
5960
  * @example
5945
5961
  * ```js
@@ -5997,14 +6013,6 @@ declare type GetLogRequestType_2 = {
5997
6013
  * The name of the running application
5998
6014
  */
5999
6015
  name: string;
6000
- /**
6001
- * The file length of the log file
6002
- */
6003
- endFile?: string;
6004
- /**
6005
- * The size limit of the log file.
6006
- */
6007
- sizeLimit?: number;
6008
6016
  };
6009
6017
 
6010
6018
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -16085,7 +16093,11 @@ declare class ViewModule extends Base {
16085
16093
  */
16086
16094
  create(options: OpenFin_2.ViewCreationOptions): Promise<OpenFin_2.View>;
16087
16095
  /**
16088
- * Asynchronously returns a View object that represents an existing view.
16096
+ * Asynchronously returns an API handle for the given View identity.
16097
+ *
16098
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16099
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16100
+ * for a View throughout its entire lifecycle.
16089
16101
  *
16090
16102
  * @example
16091
16103
  * ```js
@@ -16097,7 +16109,11 @@ declare class ViewModule extends Base {
16097
16109
  */
16098
16110
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.View>;
16099
16111
  /**
16100
- * Synchronously returns a View object that represents an existing view.
16112
+ * Synchronously returns an API handle for the given View identity.
16113
+ *
16114
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16115
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16116
+ * for a View throughout its entire lifecycle.
16101
16117
  *
16102
16118
  * @example
16103
16119
  * ```js
@@ -18545,7 +18561,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18545
18561
  */
18546
18562
  declare class _WindowModule extends Base {
18547
18563
  /**
18548
- * Asynchronously returns a Window object that represents an existing window.
18564
+ * Asynchronously returns an API handle for the given Window identity.
18565
+ *
18566
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18567
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18568
+ * for a Window throughout its entire lifecycle.
18549
18569
  *
18550
18570
  * @example
18551
18571
  * ```js
@@ -18565,7 +18585,11 @@ declare class _WindowModule extends Base {
18565
18585
  */
18566
18586
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
18567
18587
  /**
18568
- * Synchronously returns a Window object that represents an existing window.
18588
+ * Synchronously returns an API handle for the given Window identity.
18589
+ *
18590
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18591
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18592
+ * for a Window throughout its entire lifecycle.
18569
18593
  *
18570
18594
  * @example
18571
18595
  * ```js
@@ -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_2.ApplicationIdentity): Promise<OpenFin_2.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
  };
@@ -5859,6 +5867,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5859
5867
  * Returns a frame info object representing the window that the referenced iframe is
5860
5868
  * currently embedded in.
5861
5869
  *
5870
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5871
+ *
5862
5872
  * @example
5863
5873
  * ```js
5864
5874
  * async function getParentWindow() {
@@ -5926,8 +5936,11 @@ declare type FrameInfo = {
5926
5936
  */
5927
5937
  declare class _FrameModule extends Base {
5928
5938
  /**
5929
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
5930
- * @param identity - the identity of the frame you want to wrap
5939
+ * Asynchronously returns an API handle for the given Frame identity.
5940
+ *
5941
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5942
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5943
+ * for a Frame throughout its entire lifecycle.
5931
5944
  *
5932
5945
  * @example
5933
5946
  * ```js
@@ -5938,8 +5951,11 @@ declare class _FrameModule extends Base {
5938
5951
  */
5939
5952
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Frame>;
5940
5953
  /**
5941
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
5942
- * @param identity - the identity of the frame you want to wrap
5954
+ * Synchronously returns an API handle for the given Frame identity.
5955
+ *
5956
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
5957
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5958
+ * for a Frame throughout its entire lifecycle.
5943
5959
  *
5944
5960
  * @example
5945
5961
  * ```js
@@ -5997,14 +6013,6 @@ declare type GetLogRequestType_2 = {
5997
6013
  * The name of the running application
5998
6014
  */
5999
6015
  name: string;
6000
- /**
6001
- * The file length of the log file
6002
- */
6003
- endFile?: string;
6004
- /**
6005
- * The size limit of the log file.
6006
- */
6007
- sizeLimit?: number;
6008
6016
  };
6009
6017
 
6010
6018
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -16085,7 +16093,11 @@ declare class ViewModule extends Base {
16085
16093
  */
16086
16094
  create(options: OpenFin_2.ViewCreationOptions): Promise<OpenFin_2.View>;
16087
16095
  /**
16088
- * Asynchronously returns a View object that represents an existing view.
16096
+ * Asynchronously returns an API handle for the given View identity.
16097
+ *
16098
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16099
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16100
+ * for a View throughout its entire lifecycle.
16089
16101
  *
16090
16102
  * @example
16091
16103
  * ```js
@@ -16097,7 +16109,11 @@ declare class ViewModule extends Base {
16097
16109
  */
16098
16110
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.View>;
16099
16111
  /**
16100
- * Synchronously returns a View object that represents an existing view.
16112
+ * Synchronously returns an API handle for the given View identity.
16113
+ *
16114
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16115
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16116
+ * for a View throughout its entire lifecycle.
16101
16117
  *
16102
16118
  * @example
16103
16119
  * ```js
@@ -18545,7 +18561,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18545
18561
  */
18546
18562
  declare class _WindowModule extends Base {
18547
18563
  /**
18548
- * Asynchronously returns a Window object that represents an existing window.
18564
+ * Asynchronously returns an API handle for the given Window identity.
18565
+ *
18566
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18567
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18568
+ * for a Window throughout its entire lifecycle.
18549
18569
  *
18550
18570
  * @example
18551
18571
  * ```js
@@ -18565,7 +18585,11 @@ declare class _WindowModule extends Base {
18565
18585
  */
18566
18586
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
18567
18587
  /**
18568
- * Synchronously returns a Window object that represents an existing window.
18588
+ * Synchronously returns an API handle for the given Window identity.
18589
+ *
18590
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
18591
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
18592
+ * for a Window throughout its entire lifecycle.
18569
18593
  *
18570
18594
  * @example
18571
18595
  * ```js
package/out/mock.d.ts CHANGED
@@ -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_2.ApplicationIdentity): Promise<OpenFin_2.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
  };
@@ -5943,6 +5951,8 @@ declare class _Frame extends EmitterBase<OpenFin_2.FrameEvent> {
5943
5951
  * Returns a frame info object representing the window that the referenced iframe is
5944
5952
  * currently embedded in.
5945
5953
  *
5954
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
5955
+ *
5946
5956
  * @example
5947
5957
  * ```js
5948
5958
  * async function getParentWindow() {
@@ -6010,8 +6020,11 @@ declare type FrameInfo = {
6010
6020
  */
6011
6021
  declare class _FrameModule extends Base {
6012
6022
  /**
6013
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
6014
- * @param identity - the identity of the frame you want to wrap
6023
+ * Asynchronously returns an API handle for the given Frame identity.
6024
+ *
6025
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6026
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6027
+ * for a Frame throughout its entire lifecycle.
6015
6028
  *
6016
6029
  * @example
6017
6030
  * ```js
@@ -6022,8 +6035,11 @@ declare class _FrameModule extends Base {
6022
6035
  */
6023
6036
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Frame>;
6024
6037
  /**
6025
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
6026
- * @param identity - the identity of the frame you want to wrap
6038
+ * Synchronously returns an API handle for the given Frame identity.
6039
+ *
6040
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
6041
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
6042
+ * for a Frame throughout its entire lifecycle.
6027
6043
  *
6028
6044
  * @example
6029
6045
  * ```js
@@ -6081,14 +6097,6 @@ declare type GetLogRequestType_2 = {
6081
6097
  * The name of the running application
6082
6098
  */
6083
6099
  name: string;
6084
- /**
6085
- * The file length of the log file
6086
- */
6087
- endFile?: string;
6088
- /**
6089
- * The size limit of the log file.
6090
- */
6091
- sizeLimit?: number;
6092
6100
  };
6093
6101
 
6094
6102
  declare type GetterCall<T> = ApiCall<void, T>;
@@ -16524,7 +16532,11 @@ declare class ViewModule extends Base {
16524
16532
  */
16525
16533
  create(options: OpenFin_2.ViewCreationOptions): Promise<OpenFin_2.View>;
16526
16534
  /**
16527
- * Asynchronously returns a View object that represents an existing view.
16535
+ * Asynchronously returns an API handle for the given View identity.
16536
+ *
16537
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16538
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16539
+ * for a View throughout its entire lifecycle.
16528
16540
  *
16529
16541
  * @example
16530
16542
  * ```js
@@ -16536,7 +16548,11 @@ declare class ViewModule extends Base {
16536
16548
  */
16537
16549
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.View>;
16538
16550
  /**
16539
- * Synchronously returns a View object that represents an existing view.
16551
+ * Synchronously returns an API handle for the given View identity.
16552
+ *
16553
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
16554
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
16555
+ * for a View throughout its entire lifecycle.
16540
16556
  *
16541
16557
  * @example
16542
16558
  * ```js
@@ -18991,7 +19007,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
18991
19007
  */
18992
19008
  declare class _WindowModule extends Base {
18993
19009
  /**
18994
- * Asynchronously returns a Window object that represents an existing window.
19010
+ * Asynchronously returns an API handle for the given Window identity.
19011
+ *
19012
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
19013
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
19014
+ * for a Window throughout its entire lifecycle.
18995
19015
  *
18996
19016
  * @example
18997
19017
  * ```js
@@ -19011,7 +19031,11 @@ declare class _WindowModule extends Base {
19011
19031
  */
19012
19032
  wrap(identity: OpenFin_2.Identity): Promise<OpenFin_2.Window>;
19013
19033
  /**
19014
- * Synchronously returns a Window object that represents an existing window.
19034
+ * Synchronously returns an API handle for the given Window identity.
19035
+ *
19036
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
19037
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
19038
+ * for a Window throughout its entire lifecycle.
19015
19039
  *
19016
19040
  * @example
19017
19041
  * ```js
package/out/mock.js CHANGED
@@ -743,7 +743,11 @@ function requireFactory$3 () {
743
743
  return this.wrapSync({ uuid, name: options.name });
744
744
  }
745
745
  /**
746
- * Asynchronously returns a View object that represents an existing view.
746
+ * Asynchronously returns an API handle for the given View identity.
747
+ *
748
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
749
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
750
+ * for a View throughout its entire lifecycle.
747
751
  *
748
752
  * @example
749
753
  * ```js
@@ -762,7 +766,11 @@ function requireFactory$3 () {
762
766
  return new index_1.View(this.wire, identity);
763
767
  }
764
768
  /**
765
- * Synchronously returns a View object that represents an existing view.
769
+ * Synchronously returns an API handle for the given View identity.
770
+ *
771
+ * @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
772
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
773
+ * for a View throughout its entire lifecycle.
766
774
  *
767
775
  * @example
768
776
  * ```js
@@ -4054,7 +4062,11 @@ function requireFactory$2 () {
4054
4062
  */
4055
4063
  class ApplicationModule extends base_1.Base {
4056
4064
  /**
4057
- * Asynchronously returns an Application object that represents an existing application.
4065
+ * Asynchronously returns an API handle for the given Application identity.
4066
+ *
4067
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
4068
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
4069
+ * for an Application throughout its entire lifecycle.
4058
4070
  *
4059
4071
  * @example
4060
4072
  *
@@ -4077,7 +4089,11 @@ function requireFactory$2 () {
4077
4089
  return new Instance_1.Application(this.wire, identity);
4078
4090
  }
4079
4091
  /**
4080
- * Synchronously returns an Application object that represents an existing application.
4092
+ * Synchronously returns an API handle for the given Application identity.
4093
+ *
4094
+ * @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
4095
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
4096
+ * for an Aplication throughout its entire lifecycle.
4081
4097
  *
4082
4098
  * @example
4083
4099
  *
@@ -5642,7 +5658,11 @@ function requireFactory$1 () {
5642
5658
  */
5643
5659
  class _WindowModule extends base_1.Base {
5644
5660
  /**
5645
- * Asynchronously returns a Window object that represents an existing window.
5661
+ * Asynchronously returns an API handle for the given Window identity.
5662
+ *
5663
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
5664
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5665
+ * for a Window throughout its entire lifecycle.
5646
5666
  *
5647
5667
  * @example
5648
5668
  * ```js
@@ -5671,7 +5691,11 @@ function requireFactory$1 () {
5671
5691
  return new Instance_1._Window(this.wire, identity);
5672
5692
  }
5673
5693
  /**
5674
- * Synchronously returns a Window object that represents an existing window.
5694
+ * Synchronously returns an API handle for the given Window identity.
5695
+ *
5696
+ * @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
5697
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
5698
+ * for a Window throughout its entire lifecycle.
5675
5699
  *
5676
5700
  * @example
5677
5701
  * ```js
@@ -10473,6 +10497,8 @@ class _Frame extends base_1$a.EmitterBase {
10473
10497
  * Returns a frame info object representing the window that the referenced iframe is
10474
10498
  * currently embedded in.
10475
10499
  *
10500
+ * @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
10501
+ *
10476
10502
  * @example
10477
10503
  * ```js
10478
10504
  * async function getParentWindow() {
@@ -10498,8 +10524,11 @@ const Instance_1$3 = Instance$3;
10498
10524
  */
10499
10525
  class _FrameModule extends base_1$9.Base {
10500
10526
  /**
10501
- * Asynchronously returns a reference to the specified frame. The frame does not have to exist
10502
- * @param identity - the identity of the frame you want to wrap
10527
+ * Asynchronously returns an API handle for the given Frame identity.
10528
+ *
10529
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
10530
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
10531
+ * for a Frame throughout its entire lifecycle.
10503
10532
  *
10504
10533
  * @example
10505
10534
  * ```js
@@ -10519,8 +10548,11 @@ class _FrameModule extends base_1$9.Base {
10519
10548
  return new Instance_1$3._Frame(this.wire, identity);
10520
10549
  }
10521
10550
  /**
10522
- * Synchronously returns a reference to the specified frame. The frame does not have to exist
10523
- * @param identity - the identity of the frame you want to wrap
10551
+ * Synchronously returns an API handle for the given Frame identity.
10552
+ *
10553
+ * @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
10554
+ * returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
10555
+ * for a Frame throughout its entire lifecycle.
10524
10556
  *
10525
10557
  * @example
10526
10558
  * ```js
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "37.80.25",
3
+ "version": "37.80.33",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",