@openfin/node-adapter 37.80.24 → 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.
- package/out/node-adapter-alpha.d.ts +43 -19
- package/out/node-adapter-beta.d.ts +43 -19
- package/out/node-adapter-public.d.ts +43 -19
- package/out/node-adapter.d.ts +43 -19
- package/out/node-adapter.js +42 -10
- package/package.json +1 -1
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
|
|
983
983
|
*/
|
984
984
|
declare class ApplicationModule extends Base {
|
985
985
|
/**
|
986
|
-
* Asynchronously returns an
|
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
|
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
|
*
|
@@ -3812,7 +3820,7 @@ declare type ConstWindowOptions = {
|
|
3812
3820
|
*/
|
3813
3821
|
viewVisibility?: ViewVisibilityOptions;
|
3814
3822
|
/**
|
3815
|
-
* Controls whether an option is inherited from the parent application. Use {
|
3823
|
+
* 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.
|
3816
3824
|
*/
|
3817
3825
|
inheritance?: Partial<InheritableOptions>;
|
3818
3826
|
};
|
@@ -5867,6 +5875,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5867
5875
|
* Returns a frame info object representing the window that the referenced iframe is
|
5868
5876
|
* currently embedded in.
|
5869
5877
|
*
|
5878
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
5879
|
+
*
|
5870
5880
|
* @example
|
5871
5881
|
* ```js
|
5872
5882
|
* async function getParentWindow() {
|
@@ -5934,8 +5944,11 @@ declare type FrameInfo = {
|
|
5934
5944
|
*/
|
5935
5945
|
declare class _FrameModule extends Base {
|
5936
5946
|
/**
|
5937
|
-
* Asynchronously returns
|
5938
|
-
*
|
5947
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
5948
|
+
*
|
5949
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
5950
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
5951
|
+
* for a Frame throughout its entire lifecycle.
|
5939
5952
|
*
|
5940
5953
|
* @example
|
5941
5954
|
* ```js
|
@@ -5946,8 +5959,11 @@ declare class _FrameModule extends Base {
|
|
5946
5959
|
*/
|
5947
5960
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
|
5948
5961
|
/**
|
5949
|
-
* Synchronously returns
|
5950
|
-
*
|
5962
|
+
* Synchronously returns an API handle for the given Frame identity.
|
5963
|
+
*
|
5964
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
5965
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
5966
|
+
* for a Frame throughout its entire lifecycle.
|
5951
5967
|
*
|
5952
5968
|
* @example
|
5953
5969
|
* ```js
|
@@ -6005,14 +6021,6 @@ declare type GetLogRequestType_2 = {
|
|
6005
6021
|
* The name of the running application
|
6006
6022
|
*/
|
6007
6023
|
name: string;
|
6008
|
-
/**
|
6009
|
-
* The file length of the log file
|
6010
|
-
*/
|
6011
|
-
endFile?: string;
|
6012
|
-
/**
|
6013
|
-
* The size limit of the log file.
|
6014
|
-
*/
|
6015
|
-
sizeLimit?: number;
|
6016
6024
|
};
|
6017
6025
|
|
6018
6026
|
declare type GetterCall<T> = ApiCall<void, T>;
|
@@ -16095,7 +16103,11 @@ declare class ViewModule extends Base {
|
|
16095
16103
|
*/
|
16096
16104
|
create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
|
16097
16105
|
/**
|
16098
|
-
* Asynchronously returns
|
16106
|
+
* Asynchronously returns an API handle for the given View identity.
|
16107
|
+
*
|
16108
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
16109
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
16110
|
+
* for a View throughout its entire lifecycle.
|
16099
16111
|
*
|
16100
16112
|
* @example
|
16101
16113
|
* ```js
|
@@ -16107,7 +16119,11 @@ declare class ViewModule extends Base {
|
|
16107
16119
|
*/
|
16108
16120
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
|
16109
16121
|
/**
|
16110
|
-
* Synchronously returns
|
16122
|
+
* Synchronously returns an API handle for the given View identity.
|
16123
|
+
*
|
16124
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
16125
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
16126
|
+
* for a View throughout its entire lifecycle.
|
16111
16127
|
*
|
16112
16128
|
* @example
|
16113
16129
|
* ```js
|
@@ -18555,7 +18571,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
|
|
18555
18571
|
*/
|
18556
18572
|
declare class _WindowModule extends Base {
|
18557
18573
|
/**
|
18558
|
-
* Asynchronously returns
|
18574
|
+
* Asynchronously returns an API handle for the given Window identity.
|
18575
|
+
*
|
18576
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
18577
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
18578
|
+
* for a Window throughout its entire lifecycle.
|
18559
18579
|
*
|
18560
18580
|
* @example
|
18561
18581
|
* ```js
|
@@ -18575,7 +18595,11 @@ declare class _WindowModule extends Base {
|
|
18575
18595
|
*/
|
18576
18596
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
18577
18597
|
/**
|
18578
|
-
* Synchronously returns
|
18598
|
+
* Synchronously returns an API handle for the given Window identity.
|
18599
|
+
*
|
18600
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
18601
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
18602
|
+
* for a Window throughout its entire lifecycle.
|
18579
18603
|
*
|
18580
18604
|
* @example
|
18581
18605
|
* ```js
|
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
|
|
983
983
|
*/
|
984
984
|
declare class ApplicationModule extends Base {
|
985
985
|
/**
|
986
|
-
* Asynchronously returns an
|
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
|
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
|
*
|
@@ -3812,7 +3820,7 @@ declare type ConstWindowOptions = {
|
|
3812
3820
|
*/
|
3813
3821
|
viewVisibility?: ViewVisibilityOptions;
|
3814
3822
|
/**
|
3815
|
-
* Controls whether an option is inherited from the parent application. Use {
|
3823
|
+
* 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.
|
3816
3824
|
*/
|
3817
3825
|
inheritance?: Partial<InheritableOptions>;
|
3818
3826
|
};
|
@@ -5867,6 +5875,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5867
5875
|
* Returns a frame info object representing the window that the referenced iframe is
|
5868
5876
|
* currently embedded in.
|
5869
5877
|
*
|
5878
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
5879
|
+
*
|
5870
5880
|
* @example
|
5871
5881
|
* ```js
|
5872
5882
|
* async function getParentWindow() {
|
@@ -5934,8 +5944,11 @@ declare type FrameInfo = {
|
|
5934
5944
|
*/
|
5935
5945
|
declare class _FrameModule extends Base {
|
5936
5946
|
/**
|
5937
|
-
* Asynchronously returns
|
5938
|
-
*
|
5947
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
5948
|
+
*
|
5949
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
5950
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
5951
|
+
* for a Frame throughout its entire lifecycle.
|
5939
5952
|
*
|
5940
5953
|
* @example
|
5941
5954
|
* ```js
|
@@ -5946,8 +5959,11 @@ declare class _FrameModule extends Base {
|
|
5946
5959
|
*/
|
5947
5960
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
|
5948
5961
|
/**
|
5949
|
-
* Synchronously returns
|
5950
|
-
*
|
5962
|
+
* Synchronously returns an API handle for the given Frame identity.
|
5963
|
+
*
|
5964
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
5965
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
5966
|
+
* for a Frame throughout its entire lifecycle.
|
5951
5967
|
*
|
5952
5968
|
* @example
|
5953
5969
|
* ```js
|
@@ -6005,14 +6021,6 @@ declare type GetLogRequestType_2 = {
|
|
6005
6021
|
* The name of the running application
|
6006
6022
|
*/
|
6007
6023
|
name: string;
|
6008
|
-
/**
|
6009
|
-
* The file length of the log file
|
6010
|
-
*/
|
6011
|
-
endFile?: string;
|
6012
|
-
/**
|
6013
|
-
* The size limit of the log file.
|
6014
|
-
*/
|
6015
|
-
sizeLimit?: number;
|
6016
6024
|
};
|
6017
6025
|
|
6018
6026
|
declare type GetterCall<T> = ApiCall<void, T>;
|
@@ -16095,7 +16103,11 @@ declare class ViewModule extends Base {
|
|
16095
16103
|
*/
|
16096
16104
|
create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
|
16097
16105
|
/**
|
16098
|
-
* Asynchronously returns
|
16106
|
+
* Asynchronously returns an API handle for the given View identity.
|
16107
|
+
*
|
16108
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
16109
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
16110
|
+
* for a View throughout its entire lifecycle.
|
16099
16111
|
*
|
16100
16112
|
* @example
|
16101
16113
|
* ```js
|
@@ -16107,7 +16119,11 @@ declare class ViewModule extends Base {
|
|
16107
16119
|
*/
|
16108
16120
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
|
16109
16121
|
/**
|
16110
|
-
* Synchronously returns
|
16122
|
+
* Synchronously returns an API handle for the given View identity.
|
16123
|
+
*
|
16124
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
16125
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
16126
|
+
* for a View throughout its entire lifecycle.
|
16111
16127
|
*
|
16112
16128
|
* @example
|
16113
16129
|
* ```js
|
@@ -18555,7 +18571,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
|
|
18555
18571
|
*/
|
18556
18572
|
declare class _WindowModule extends Base {
|
18557
18573
|
/**
|
18558
|
-
* Asynchronously returns
|
18574
|
+
* Asynchronously returns an API handle for the given Window identity.
|
18575
|
+
*
|
18576
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
18577
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
18578
|
+
* for a Window throughout its entire lifecycle.
|
18559
18579
|
*
|
18560
18580
|
* @example
|
18561
18581
|
* ```js
|
@@ -18575,7 +18595,11 @@ declare class _WindowModule extends Base {
|
|
18575
18595
|
*/
|
18576
18596
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
18577
18597
|
/**
|
18578
|
-
* Synchronously returns
|
18598
|
+
* Synchronously returns an API handle for the given Window identity.
|
18599
|
+
*
|
18600
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
18601
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
18602
|
+
* for a Window throughout its entire lifecycle.
|
18579
18603
|
*
|
18580
18604
|
* @example
|
18581
18605
|
* ```js
|
@@ -983,7 +983,11 @@ declare type ApplicationInfo = {
|
|
983
983
|
*/
|
984
984
|
declare class ApplicationModule extends Base {
|
985
985
|
/**
|
986
|
-
* Asynchronously returns an
|
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
|
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
|
*
|
@@ -3812,7 +3820,7 @@ declare type ConstWindowOptions = {
|
|
3812
3820
|
*/
|
3813
3821
|
viewVisibility?: ViewVisibilityOptions;
|
3814
3822
|
/**
|
3815
|
-
* Controls whether an option is inherited from the parent application. Use {
|
3823
|
+
* 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.
|
3816
3824
|
*/
|
3817
3825
|
inheritance?: Partial<InheritableOptions>;
|
3818
3826
|
};
|
@@ -5867,6 +5875,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5867
5875
|
* Returns a frame info object representing the window that the referenced iframe is
|
5868
5876
|
* currently embedded in.
|
5869
5877
|
*
|
5878
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
5879
|
+
*
|
5870
5880
|
* @example
|
5871
5881
|
* ```js
|
5872
5882
|
* async function getParentWindow() {
|
@@ -5934,8 +5944,11 @@ declare type FrameInfo = {
|
|
5934
5944
|
*/
|
5935
5945
|
declare class _FrameModule extends Base {
|
5936
5946
|
/**
|
5937
|
-
* Asynchronously returns
|
5938
|
-
*
|
5947
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
5948
|
+
*
|
5949
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
5950
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
5951
|
+
* for a Frame throughout its entire lifecycle.
|
5939
5952
|
*
|
5940
5953
|
* @example
|
5941
5954
|
* ```js
|
@@ -5946,8 +5959,11 @@ declare class _FrameModule extends Base {
|
|
5946
5959
|
*/
|
5947
5960
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
|
5948
5961
|
/**
|
5949
|
-
* Synchronously returns
|
5950
|
-
*
|
5962
|
+
* Synchronously returns an API handle for the given Frame identity.
|
5963
|
+
*
|
5964
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
5965
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
5966
|
+
* for a Frame throughout its entire lifecycle.
|
5951
5967
|
*
|
5952
5968
|
* @example
|
5953
5969
|
* ```js
|
@@ -6005,14 +6021,6 @@ declare type GetLogRequestType_2 = {
|
|
6005
6021
|
* The name of the running application
|
6006
6022
|
*/
|
6007
6023
|
name: string;
|
6008
|
-
/**
|
6009
|
-
* The file length of the log file
|
6010
|
-
*/
|
6011
|
-
endFile?: string;
|
6012
|
-
/**
|
6013
|
-
* The size limit of the log file.
|
6014
|
-
*/
|
6015
|
-
sizeLimit?: number;
|
6016
6024
|
};
|
6017
6025
|
|
6018
6026
|
declare type GetterCall<T> = ApiCall<void, T>;
|
@@ -16095,7 +16103,11 @@ declare class ViewModule extends Base {
|
|
16095
16103
|
*/
|
16096
16104
|
create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
|
16097
16105
|
/**
|
16098
|
-
* Asynchronously returns
|
16106
|
+
* Asynchronously returns an API handle for the given View identity.
|
16107
|
+
*
|
16108
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
16109
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
16110
|
+
* for a View throughout its entire lifecycle.
|
16099
16111
|
*
|
16100
16112
|
* @example
|
16101
16113
|
* ```js
|
@@ -16107,7 +16119,11 @@ declare class ViewModule extends Base {
|
|
16107
16119
|
*/
|
16108
16120
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
|
16109
16121
|
/**
|
16110
|
-
* Synchronously returns
|
16122
|
+
* Synchronously returns an API handle for the given View identity.
|
16123
|
+
*
|
16124
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
16125
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
16126
|
+
* for a View throughout its entire lifecycle.
|
16111
16127
|
*
|
16112
16128
|
* @example
|
16113
16129
|
* ```js
|
@@ -18555,7 +18571,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
|
|
18555
18571
|
*/
|
18556
18572
|
declare class _WindowModule extends Base {
|
18557
18573
|
/**
|
18558
|
-
* Asynchronously returns
|
18574
|
+
* Asynchronously returns an API handle for the given Window identity.
|
18575
|
+
*
|
18576
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
18577
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
18578
|
+
* for a Window throughout its entire lifecycle.
|
18559
18579
|
*
|
18560
18580
|
* @example
|
18561
18581
|
* ```js
|
@@ -18575,7 +18595,11 @@ declare class _WindowModule extends Base {
|
|
18575
18595
|
*/
|
18576
18596
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
18577
18597
|
/**
|
18578
|
-
* Synchronously returns
|
18598
|
+
* Synchronously returns an API handle for the given Window identity.
|
18599
|
+
*
|
18600
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
18601
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
18602
|
+
* for a Window throughout its entire lifecycle.
|
18579
18603
|
*
|
18580
18604
|
* @example
|
18581
18605
|
* ```js
|
package/out/node-adapter.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
|
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
|
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
|
*
|
@@ -3867,7 +3875,7 @@ declare type ConstWindowOptions = {
|
|
3867
3875
|
*/
|
3868
3876
|
viewVisibility?: ViewVisibilityOptions;
|
3869
3877
|
/**
|
3870
|
-
* Controls whether an option is inherited from the parent application. Use {
|
3878
|
+
* 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.
|
3871
3879
|
*/
|
3872
3880
|
inheritance?: Partial<InheritableOptions>;
|
3873
3881
|
};
|
@@ -5973,6 +5981,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
5973
5981
|
* Returns a frame info object representing the window that the referenced iframe is
|
5974
5982
|
* currently embedded in.
|
5975
5983
|
*
|
5984
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
5985
|
+
*
|
5976
5986
|
* @example
|
5977
5987
|
* ```js
|
5978
5988
|
* async function getParentWindow() {
|
@@ -6040,8 +6050,11 @@ declare type FrameInfo = {
|
|
6040
6050
|
*/
|
6041
6051
|
declare class _FrameModule extends Base {
|
6042
6052
|
/**
|
6043
|
-
* Asynchronously returns
|
6044
|
-
*
|
6053
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
6054
|
+
*
|
6055
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
6056
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
6057
|
+
* for a Frame throughout its entire lifecycle.
|
6045
6058
|
*
|
6046
6059
|
* @example
|
6047
6060
|
* ```js
|
@@ -6052,8 +6065,11 @@ declare class _FrameModule extends Base {
|
|
6052
6065
|
*/
|
6053
6066
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
|
6054
6067
|
/**
|
6055
|
-
* Synchronously returns
|
6056
|
-
*
|
6068
|
+
* Synchronously returns an API handle for the given Frame identity.
|
6069
|
+
*
|
6070
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
6071
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
6072
|
+
* for a Frame throughout its entire lifecycle.
|
6057
6073
|
*
|
6058
6074
|
* @example
|
6059
6075
|
* ```js
|
@@ -6111,14 +6127,6 @@ declare type GetLogRequestType_2 = {
|
|
6111
6127
|
* The name of the running application
|
6112
6128
|
*/
|
6113
6129
|
name: string;
|
6114
|
-
/**
|
6115
|
-
* The file length of the log file
|
6116
|
-
*/
|
6117
|
-
endFile?: string;
|
6118
|
-
/**
|
6119
|
-
* The size limit of the log file.
|
6120
|
-
*/
|
6121
|
-
sizeLimit?: number;
|
6122
6130
|
};
|
6123
6131
|
|
6124
6132
|
declare type GetterCall<T> = ApiCall<void, T>;
|
@@ -16556,7 +16564,11 @@ declare class ViewModule extends Base {
|
|
16556
16564
|
*/
|
16557
16565
|
create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
|
16558
16566
|
/**
|
16559
|
-
* Asynchronously returns
|
16567
|
+
* Asynchronously returns an API handle for the given View identity.
|
16568
|
+
*
|
16569
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
16570
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
16571
|
+
* for a View throughout its entire lifecycle.
|
16560
16572
|
*
|
16561
16573
|
* @example
|
16562
16574
|
* ```js
|
@@ -16568,7 +16580,11 @@ declare class ViewModule extends Base {
|
|
16568
16580
|
*/
|
16569
16581
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
|
16570
16582
|
/**
|
16571
|
-
* Synchronously returns
|
16583
|
+
* Synchronously returns an API handle for the given View identity.
|
16584
|
+
*
|
16585
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
16586
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
16587
|
+
* for a View throughout its entire lifecycle.
|
16572
16588
|
*
|
16573
16589
|
* @example
|
16574
16590
|
* ```js
|
@@ -19023,7 +19039,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
|
|
19023
19039
|
*/
|
19024
19040
|
declare class _WindowModule extends Base {
|
19025
19041
|
/**
|
19026
|
-
* Asynchronously returns
|
19042
|
+
* Asynchronously returns an API handle for the given Window identity.
|
19043
|
+
*
|
19044
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
19045
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
19046
|
+
* for a Window throughout its entire lifecycle.
|
19027
19047
|
*
|
19028
19048
|
* @example
|
19029
19049
|
* ```js
|
@@ -19043,7 +19063,11 @@ declare class _WindowModule extends Base {
|
|
19043
19063
|
*/
|
19044
19064
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
19045
19065
|
/**
|
19046
|
-
* Synchronously returns
|
19066
|
+
* Synchronously returns an API handle for the given Window identity.
|
19067
|
+
*
|
19068
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
19069
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
19070
|
+
* for a Window throughout its entire lifecycle.
|
19047
19071
|
*
|
19048
19072
|
* @example
|
19049
19073
|
* ```js
|
package/out/node-adapter.js
CHANGED
@@ -516,7 +516,11 @@ function requireFactory$3 () {
|
|
516
516
|
return this.wrapSync({ uuid, name: options.name });
|
517
517
|
}
|
518
518
|
/**
|
519
|
-
* Asynchronously returns
|
519
|
+
* Asynchronously returns an API handle for the given View identity.
|
520
|
+
*
|
521
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
522
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
523
|
+
* for a View throughout its entire lifecycle.
|
520
524
|
*
|
521
525
|
* @example
|
522
526
|
* ```js
|
@@ -535,7 +539,11 @@ function requireFactory$3 () {
|
|
535
539
|
return new index_1.View(this.wire, identity);
|
536
540
|
}
|
537
541
|
/**
|
538
|
-
* Synchronously returns
|
542
|
+
* Synchronously returns an API handle for the given View identity.
|
543
|
+
*
|
544
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
545
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
546
|
+
* for a View throughout its entire lifecycle.
|
539
547
|
*
|
540
548
|
* @example
|
541
549
|
* ```js
|
@@ -3827,7 +3835,11 @@ function requireFactory$2 () {
|
|
3827
3835
|
*/
|
3828
3836
|
class ApplicationModule extends base_1.Base {
|
3829
3837
|
/**
|
3830
|
-
* Asynchronously returns an
|
3838
|
+
* Asynchronously returns an API handle for the given Application identity.
|
3839
|
+
*
|
3840
|
+
* @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
|
3841
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
3842
|
+
* for an Application throughout its entire lifecycle.
|
3831
3843
|
*
|
3832
3844
|
* @example
|
3833
3845
|
*
|
@@ -3850,7 +3862,11 @@ function requireFactory$2 () {
|
|
3850
3862
|
return new Instance_1.Application(this.wire, identity);
|
3851
3863
|
}
|
3852
3864
|
/**
|
3853
|
-
* Synchronously returns an
|
3865
|
+
* Synchronously returns an API handle for the given Application identity.
|
3866
|
+
*
|
3867
|
+
* @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
|
3868
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
3869
|
+
* for an Aplication throughout its entire lifecycle.
|
3854
3870
|
*
|
3855
3871
|
* @example
|
3856
3872
|
*
|
@@ -5415,7 +5431,11 @@ function requireFactory$1 () {
|
|
5415
5431
|
*/
|
5416
5432
|
class _WindowModule extends base_1.Base {
|
5417
5433
|
/**
|
5418
|
-
* Asynchronously returns
|
5434
|
+
* Asynchronously returns an API handle for the given Window identity.
|
5435
|
+
*
|
5436
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
5437
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
5438
|
+
* for a Window throughout its entire lifecycle.
|
5419
5439
|
*
|
5420
5440
|
* @example
|
5421
5441
|
* ```js
|
@@ -5444,7 +5464,11 @@ function requireFactory$1 () {
|
|
5444
5464
|
return new Instance_1._Window(this.wire, identity);
|
5445
5465
|
}
|
5446
5466
|
/**
|
5447
|
-
* Synchronously returns
|
5467
|
+
* Synchronously returns an API handle for the given Window identity.
|
5468
|
+
*
|
5469
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
5470
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
5471
|
+
* for a Window throughout its entire lifecycle.
|
5448
5472
|
*
|
5449
5473
|
* @example
|
5450
5474
|
* ```js
|
@@ -10246,6 +10270,8 @@ class _Frame extends base_1$a.EmitterBase {
|
|
10246
10270
|
* Returns a frame info object representing the window that the referenced iframe is
|
10247
10271
|
* currently embedded in.
|
10248
10272
|
*
|
10273
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
10274
|
+
*
|
10249
10275
|
* @example
|
10250
10276
|
* ```js
|
10251
10277
|
* async function getParentWindow() {
|
@@ -10271,8 +10297,11 @@ const Instance_1$3 = Instance$3;
|
|
10271
10297
|
*/
|
10272
10298
|
class _FrameModule extends base_1$9.Base {
|
10273
10299
|
/**
|
10274
|
-
* Asynchronously returns
|
10275
|
-
*
|
10300
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
10301
|
+
*
|
10302
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
10303
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
10304
|
+
* for a Frame throughout its entire lifecycle.
|
10276
10305
|
*
|
10277
10306
|
* @example
|
10278
10307
|
* ```js
|
@@ -10292,8 +10321,11 @@ class _FrameModule extends base_1$9.Base {
|
|
10292
10321
|
return new Instance_1$3._Frame(this.wire, identity);
|
10293
10322
|
}
|
10294
10323
|
/**
|
10295
|
-
* Synchronously returns
|
10296
|
-
*
|
10324
|
+
* Synchronously returns an API handle for the given Frame identity.
|
10325
|
+
*
|
10326
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
10327
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
10328
|
+
* for a Frame throughout its entire lifecycle.
|
10297
10329
|
*
|
10298
10330
|
* @example
|
10299
10331
|
* ```js
|