@openfin/remote-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/remote-adapter-alpha.d.ts +43 -19
- package/out/remote-adapter-beta.d.ts +43 -19
- package/out/remote-adapter-public.d.ts +43 -19
- package/out/remote-adapter.d.ts +43 -19
- package/out/remote-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
|
*
|
|
@@ -3832,7 +3840,7 @@ declare type ConstWindowOptions = {
|
|
|
3832
3840
|
*/
|
|
3833
3841
|
viewVisibility?: ViewVisibilityOptions;
|
|
3834
3842
|
/**
|
|
3835
|
-
* Controls whether an option is inherited from the parent application. Use {
|
|
3843
|
+
* 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.
|
|
3836
3844
|
*/
|
|
3837
3845
|
inheritance?: Partial<InheritableOptions>;
|
|
3838
3846
|
};
|
|
@@ -5881,6 +5889,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
|
5881
5889
|
* Returns a frame info object representing the window that the referenced iframe is
|
|
5882
5890
|
* currently embedded in.
|
|
5883
5891
|
*
|
|
5892
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
|
5893
|
+
*
|
|
5884
5894
|
* @example
|
|
5885
5895
|
* ```js
|
|
5886
5896
|
* async function getParentWindow() {
|
|
@@ -5948,8 +5958,11 @@ declare type FrameInfo = {
|
|
|
5948
5958
|
*/
|
|
5949
5959
|
declare class _FrameModule extends Base {
|
|
5950
5960
|
/**
|
|
5951
|
-
* Asynchronously returns
|
|
5952
|
-
*
|
|
5961
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
|
5962
|
+
*
|
|
5963
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
5964
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
5965
|
+
* for a Frame throughout its entire lifecycle.
|
|
5953
5966
|
*
|
|
5954
5967
|
* @example
|
|
5955
5968
|
* ```js
|
|
@@ -5960,8 +5973,11 @@ declare class _FrameModule extends Base {
|
|
|
5960
5973
|
*/
|
|
5961
5974
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
|
|
5962
5975
|
/**
|
|
5963
|
-
* Synchronously returns
|
|
5964
|
-
*
|
|
5976
|
+
* Synchronously returns an API handle for the given Frame identity.
|
|
5977
|
+
*
|
|
5978
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
5979
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
5980
|
+
* for a Frame throughout its entire lifecycle.
|
|
5965
5981
|
*
|
|
5966
5982
|
* @example
|
|
5967
5983
|
* ```js
|
|
@@ -6019,14 +6035,6 @@ declare type GetLogRequestType_2 = {
|
|
|
6019
6035
|
* The name of the running application
|
|
6020
6036
|
*/
|
|
6021
6037
|
name: string;
|
|
6022
|
-
/**
|
|
6023
|
-
* The file length of the log file
|
|
6024
|
-
*/
|
|
6025
|
-
endFile?: string;
|
|
6026
|
-
/**
|
|
6027
|
-
* The size limit of the log file.
|
|
6028
|
-
*/
|
|
6029
|
-
sizeLimit?: number;
|
|
6030
6038
|
};
|
|
6031
6039
|
|
|
6032
6040
|
declare type GetterCall<T> = ApiCall<void, T>;
|
|
@@ -16127,7 +16135,11 @@ declare class ViewModule extends Base {
|
|
|
16127
16135
|
*/
|
|
16128
16136
|
create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
|
|
16129
16137
|
/**
|
|
16130
|
-
* Asynchronously returns
|
|
16138
|
+
* Asynchronously returns an API handle for the given View identity.
|
|
16139
|
+
*
|
|
16140
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
16141
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
16142
|
+
* for a View throughout its entire lifecycle.
|
|
16131
16143
|
*
|
|
16132
16144
|
* @example
|
|
16133
16145
|
* ```js
|
|
@@ -16139,7 +16151,11 @@ declare class ViewModule extends Base {
|
|
|
16139
16151
|
*/
|
|
16140
16152
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
|
|
16141
16153
|
/**
|
|
16142
|
-
* Synchronously returns
|
|
16154
|
+
* Synchronously returns an API handle for the given View identity.
|
|
16155
|
+
*
|
|
16156
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
16157
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
16158
|
+
* for a View throughout its entire lifecycle.
|
|
16143
16159
|
*
|
|
16144
16160
|
* @example
|
|
16145
16161
|
* ```js
|
|
@@ -18587,7 +18603,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
|
|
|
18587
18603
|
*/
|
|
18588
18604
|
declare class _WindowModule extends Base {
|
|
18589
18605
|
/**
|
|
18590
|
-
* Asynchronously returns
|
|
18606
|
+
* Asynchronously returns an API handle for the given Window identity.
|
|
18607
|
+
*
|
|
18608
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
18609
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
18610
|
+
* for a Window throughout its entire lifecycle.
|
|
18591
18611
|
*
|
|
18592
18612
|
* @example
|
|
18593
18613
|
* ```js
|
|
@@ -18607,7 +18627,11 @@ declare class _WindowModule extends Base {
|
|
|
18607
18627
|
*/
|
|
18608
18628
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
|
18609
18629
|
/**
|
|
18610
|
-
* Synchronously returns
|
|
18630
|
+
* Synchronously returns an API handle for the given Window identity.
|
|
18631
|
+
*
|
|
18632
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
18633
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
18634
|
+
* for a Window throughout its entire lifecycle.
|
|
18611
18635
|
*
|
|
18612
18636
|
* @example
|
|
18613
18637
|
* ```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
|
*
|
|
@@ -3832,7 +3840,7 @@ declare type ConstWindowOptions = {
|
|
|
3832
3840
|
*/
|
|
3833
3841
|
viewVisibility?: ViewVisibilityOptions;
|
|
3834
3842
|
/**
|
|
3835
|
-
* Controls whether an option is inherited from the parent application. Use {
|
|
3843
|
+
* 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.
|
|
3836
3844
|
*/
|
|
3837
3845
|
inheritance?: Partial<InheritableOptions>;
|
|
3838
3846
|
};
|
|
@@ -5881,6 +5889,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
|
5881
5889
|
* Returns a frame info object representing the window that the referenced iframe is
|
|
5882
5890
|
* currently embedded in.
|
|
5883
5891
|
*
|
|
5892
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
|
5893
|
+
*
|
|
5884
5894
|
* @example
|
|
5885
5895
|
* ```js
|
|
5886
5896
|
* async function getParentWindow() {
|
|
@@ -5948,8 +5958,11 @@ declare type FrameInfo = {
|
|
|
5948
5958
|
*/
|
|
5949
5959
|
declare class _FrameModule extends Base {
|
|
5950
5960
|
/**
|
|
5951
|
-
* Asynchronously returns
|
|
5952
|
-
*
|
|
5961
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
|
5962
|
+
*
|
|
5963
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
5964
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
5965
|
+
* for a Frame throughout its entire lifecycle.
|
|
5953
5966
|
*
|
|
5954
5967
|
* @example
|
|
5955
5968
|
* ```js
|
|
@@ -5960,8 +5973,11 @@ declare class _FrameModule extends Base {
|
|
|
5960
5973
|
*/
|
|
5961
5974
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
|
|
5962
5975
|
/**
|
|
5963
|
-
* Synchronously returns
|
|
5964
|
-
*
|
|
5976
|
+
* Synchronously returns an API handle for the given Frame identity.
|
|
5977
|
+
*
|
|
5978
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
5979
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
5980
|
+
* for a Frame throughout its entire lifecycle.
|
|
5965
5981
|
*
|
|
5966
5982
|
* @example
|
|
5967
5983
|
* ```js
|
|
@@ -6019,14 +6035,6 @@ declare type GetLogRequestType_2 = {
|
|
|
6019
6035
|
* The name of the running application
|
|
6020
6036
|
*/
|
|
6021
6037
|
name: string;
|
|
6022
|
-
/**
|
|
6023
|
-
* The file length of the log file
|
|
6024
|
-
*/
|
|
6025
|
-
endFile?: string;
|
|
6026
|
-
/**
|
|
6027
|
-
* The size limit of the log file.
|
|
6028
|
-
*/
|
|
6029
|
-
sizeLimit?: number;
|
|
6030
6038
|
};
|
|
6031
6039
|
|
|
6032
6040
|
declare type GetterCall<T> = ApiCall<void, T>;
|
|
@@ -16127,7 +16135,11 @@ declare class ViewModule extends Base {
|
|
|
16127
16135
|
*/
|
|
16128
16136
|
create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
|
|
16129
16137
|
/**
|
|
16130
|
-
* Asynchronously returns
|
|
16138
|
+
* Asynchronously returns an API handle for the given View identity.
|
|
16139
|
+
*
|
|
16140
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
16141
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
16142
|
+
* for a View throughout its entire lifecycle.
|
|
16131
16143
|
*
|
|
16132
16144
|
* @example
|
|
16133
16145
|
* ```js
|
|
@@ -16139,7 +16151,11 @@ declare class ViewModule extends Base {
|
|
|
16139
16151
|
*/
|
|
16140
16152
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
|
|
16141
16153
|
/**
|
|
16142
|
-
* Synchronously returns
|
|
16154
|
+
* Synchronously returns an API handle for the given View identity.
|
|
16155
|
+
*
|
|
16156
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
16157
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
16158
|
+
* for a View throughout its entire lifecycle.
|
|
16143
16159
|
*
|
|
16144
16160
|
* @example
|
|
16145
16161
|
* ```js
|
|
@@ -18587,7 +18603,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
|
|
|
18587
18603
|
*/
|
|
18588
18604
|
declare class _WindowModule extends Base {
|
|
18589
18605
|
/**
|
|
18590
|
-
* Asynchronously returns
|
|
18606
|
+
* Asynchronously returns an API handle for the given Window identity.
|
|
18607
|
+
*
|
|
18608
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
18609
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
18610
|
+
* for a Window throughout its entire lifecycle.
|
|
18591
18611
|
*
|
|
18592
18612
|
* @example
|
|
18593
18613
|
* ```js
|
|
@@ -18607,7 +18627,11 @@ declare class _WindowModule extends Base {
|
|
|
18607
18627
|
*/
|
|
18608
18628
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
|
18609
18629
|
/**
|
|
18610
|
-
* Synchronously returns
|
|
18630
|
+
* Synchronously returns an API handle for the given Window identity.
|
|
18631
|
+
*
|
|
18632
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
18633
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
18634
|
+
* for a Window throughout its entire lifecycle.
|
|
18611
18635
|
*
|
|
18612
18636
|
* @example
|
|
18613
18637
|
* ```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
|
*
|
|
@@ -3832,7 +3840,7 @@ declare type ConstWindowOptions = {
|
|
|
3832
3840
|
*/
|
|
3833
3841
|
viewVisibility?: ViewVisibilityOptions;
|
|
3834
3842
|
/**
|
|
3835
|
-
* Controls whether an option is inherited from the parent application. Use {
|
|
3843
|
+
* 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.
|
|
3836
3844
|
*/
|
|
3837
3845
|
inheritance?: Partial<InheritableOptions>;
|
|
3838
3846
|
};
|
|
@@ -5881,6 +5889,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
|
5881
5889
|
* Returns a frame info object representing the window that the referenced iframe is
|
|
5882
5890
|
* currently embedded in.
|
|
5883
5891
|
*
|
|
5892
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
|
5893
|
+
*
|
|
5884
5894
|
* @example
|
|
5885
5895
|
* ```js
|
|
5886
5896
|
* async function getParentWindow() {
|
|
@@ -5948,8 +5958,11 @@ declare type FrameInfo = {
|
|
|
5948
5958
|
*/
|
|
5949
5959
|
declare class _FrameModule extends Base {
|
|
5950
5960
|
/**
|
|
5951
|
-
* Asynchronously returns
|
|
5952
|
-
*
|
|
5961
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
|
5962
|
+
*
|
|
5963
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
5964
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
5965
|
+
* for a Frame throughout its entire lifecycle.
|
|
5953
5966
|
*
|
|
5954
5967
|
* @example
|
|
5955
5968
|
* ```js
|
|
@@ -5960,8 +5973,11 @@ declare class _FrameModule extends Base {
|
|
|
5960
5973
|
*/
|
|
5961
5974
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
|
|
5962
5975
|
/**
|
|
5963
|
-
* Synchronously returns
|
|
5964
|
-
*
|
|
5976
|
+
* Synchronously returns an API handle for the given Frame identity.
|
|
5977
|
+
*
|
|
5978
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
5979
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
5980
|
+
* for a Frame throughout its entire lifecycle.
|
|
5965
5981
|
*
|
|
5966
5982
|
* @example
|
|
5967
5983
|
* ```js
|
|
@@ -6019,14 +6035,6 @@ declare type GetLogRequestType_2 = {
|
|
|
6019
6035
|
* The name of the running application
|
|
6020
6036
|
*/
|
|
6021
6037
|
name: string;
|
|
6022
|
-
/**
|
|
6023
|
-
* The file length of the log file
|
|
6024
|
-
*/
|
|
6025
|
-
endFile?: string;
|
|
6026
|
-
/**
|
|
6027
|
-
* The size limit of the log file.
|
|
6028
|
-
*/
|
|
6029
|
-
sizeLimit?: number;
|
|
6030
6038
|
};
|
|
6031
6039
|
|
|
6032
6040
|
declare type GetterCall<T> = ApiCall<void, T>;
|
|
@@ -16127,7 +16135,11 @@ declare class ViewModule extends Base {
|
|
|
16127
16135
|
*/
|
|
16128
16136
|
create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
|
|
16129
16137
|
/**
|
|
16130
|
-
* Asynchronously returns
|
|
16138
|
+
* Asynchronously returns an API handle for the given View identity.
|
|
16139
|
+
*
|
|
16140
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
16141
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
16142
|
+
* for a View throughout its entire lifecycle.
|
|
16131
16143
|
*
|
|
16132
16144
|
* @example
|
|
16133
16145
|
* ```js
|
|
@@ -16139,7 +16151,11 @@ declare class ViewModule extends Base {
|
|
|
16139
16151
|
*/
|
|
16140
16152
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
|
|
16141
16153
|
/**
|
|
16142
|
-
* Synchronously returns
|
|
16154
|
+
* Synchronously returns an API handle for the given View identity.
|
|
16155
|
+
*
|
|
16156
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
16157
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
16158
|
+
* for a View throughout its entire lifecycle.
|
|
16143
16159
|
*
|
|
16144
16160
|
* @example
|
|
16145
16161
|
* ```js
|
|
@@ -18587,7 +18603,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
|
|
|
18587
18603
|
*/
|
|
18588
18604
|
declare class _WindowModule extends Base {
|
|
18589
18605
|
/**
|
|
18590
|
-
* Asynchronously returns
|
|
18606
|
+
* Asynchronously returns an API handle for the given Window identity.
|
|
18607
|
+
*
|
|
18608
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
18609
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
18610
|
+
* for a Window throughout its entire lifecycle.
|
|
18591
18611
|
*
|
|
18592
18612
|
* @example
|
|
18593
18613
|
* ```js
|
|
@@ -18607,7 +18627,11 @@ declare class _WindowModule extends Base {
|
|
|
18607
18627
|
*/
|
|
18608
18628
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
|
18609
18629
|
/**
|
|
18610
|
-
* Synchronously returns
|
|
18630
|
+
* Synchronously returns an API handle for the given Window identity.
|
|
18631
|
+
*
|
|
18632
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
18633
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
18634
|
+
* for a Window throughout its entire lifecycle.
|
|
18611
18635
|
*
|
|
18612
18636
|
* @example
|
|
18613
18637
|
* ```js
|
package/out/remote-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
|
*
|
|
@@ -3887,7 +3895,7 @@ declare type ConstWindowOptions = {
|
|
|
3887
3895
|
*/
|
|
3888
3896
|
viewVisibility?: ViewVisibilityOptions;
|
|
3889
3897
|
/**
|
|
3890
|
-
* Controls whether an option is inherited from the parent application. Use {
|
|
3898
|
+
* 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.
|
|
3891
3899
|
*/
|
|
3892
3900
|
inheritance?: Partial<InheritableOptions>;
|
|
3893
3901
|
};
|
|
@@ -5965,6 +5973,8 @@ declare class _Frame extends EmitterBase<OpenFin.FrameEvent> {
|
|
|
5965
5973
|
* Returns a frame info object representing the window that the referenced iframe is
|
|
5966
5974
|
* currently embedded in.
|
|
5967
5975
|
*
|
|
5976
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
|
5977
|
+
*
|
|
5968
5978
|
* @example
|
|
5969
5979
|
* ```js
|
|
5970
5980
|
* async function getParentWindow() {
|
|
@@ -6032,8 +6042,11 @@ declare type FrameInfo = {
|
|
|
6032
6042
|
*/
|
|
6033
6043
|
declare class _FrameModule extends Base {
|
|
6034
6044
|
/**
|
|
6035
|
-
* Asynchronously returns
|
|
6036
|
-
*
|
|
6045
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
|
6046
|
+
*
|
|
6047
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
6048
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
6049
|
+
* for a Frame throughout its entire lifecycle.
|
|
6037
6050
|
*
|
|
6038
6051
|
* @example
|
|
6039
6052
|
* ```js
|
|
@@ -6044,8 +6057,11 @@ declare class _FrameModule extends Base {
|
|
|
6044
6057
|
*/
|
|
6045
6058
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Frame>;
|
|
6046
6059
|
/**
|
|
6047
|
-
* Synchronously returns
|
|
6048
|
-
*
|
|
6060
|
+
* Synchronously returns an API handle for the given Frame identity.
|
|
6061
|
+
*
|
|
6062
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
6063
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
6064
|
+
* for a Frame throughout its entire lifecycle.
|
|
6049
6065
|
*
|
|
6050
6066
|
* @example
|
|
6051
6067
|
* ```js
|
|
@@ -6103,14 +6119,6 @@ declare type GetLogRequestType_2 = {
|
|
|
6103
6119
|
* The name of the running application
|
|
6104
6120
|
*/
|
|
6105
6121
|
name: string;
|
|
6106
|
-
/**
|
|
6107
|
-
* The file length of the log file
|
|
6108
|
-
*/
|
|
6109
|
-
endFile?: string;
|
|
6110
|
-
/**
|
|
6111
|
-
* The size limit of the log file.
|
|
6112
|
-
*/
|
|
6113
|
-
sizeLimit?: number;
|
|
6114
6122
|
};
|
|
6115
6123
|
|
|
6116
6124
|
declare type GetterCall<T> = ApiCall<void, T>;
|
|
@@ -16566,7 +16574,11 @@ declare class ViewModule extends Base {
|
|
|
16566
16574
|
*/
|
|
16567
16575
|
create(options: OpenFin.ViewCreationOptions): Promise<OpenFin.View>;
|
|
16568
16576
|
/**
|
|
16569
|
-
* Asynchronously returns
|
|
16577
|
+
* Asynchronously returns an API handle for the given View identity.
|
|
16578
|
+
*
|
|
16579
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
16580
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
16581
|
+
* for a View throughout its entire lifecycle.
|
|
16570
16582
|
*
|
|
16571
16583
|
* @example
|
|
16572
16584
|
* ```js
|
|
@@ -16578,7 +16590,11 @@ declare class ViewModule extends Base {
|
|
|
16578
16590
|
*/
|
|
16579
16591
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.View>;
|
|
16580
16592
|
/**
|
|
16581
|
-
* Synchronously returns
|
|
16593
|
+
* Synchronously returns an API handle for the given View identity.
|
|
16594
|
+
*
|
|
16595
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
16596
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
16597
|
+
* for a View throughout its entire lifecycle.
|
|
16582
16598
|
*
|
|
16583
16599
|
* @example
|
|
16584
16600
|
* ```js
|
|
@@ -19033,7 +19049,11 @@ declare type WindowInitializedEvent = InitializedEvent_2;
|
|
|
19033
19049
|
*/
|
|
19034
19050
|
declare class _WindowModule extends Base {
|
|
19035
19051
|
/**
|
|
19036
|
-
* Asynchronously returns
|
|
19052
|
+
* Asynchronously returns an API handle for the given Window identity.
|
|
19053
|
+
*
|
|
19054
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
19055
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
19056
|
+
* for a Window throughout its entire lifecycle.
|
|
19037
19057
|
*
|
|
19038
19058
|
* @example
|
|
19039
19059
|
* ```js
|
|
@@ -19053,7 +19073,11 @@ declare class _WindowModule extends Base {
|
|
|
19053
19073
|
*/
|
|
19054
19074
|
wrap(identity: OpenFin.Identity): Promise<OpenFin.Window>;
|
|
19055
19075
|
/**
|
|
19056
|
-
* Synchronously returns
|
|
19076
|
+
* Synchronously returns an API handle for the given Window identity.
|
|
19077
|
+
*
|
|
19078
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
19079
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
19080
|
+
* for a Window throughout its entire lifecycle.
|
|
19057
19081
|
*
|
|
19058
19082
|
* @example
|
|
19059
19083
|
* ```js
|
package/out/remote-adapter.js
CHANGED
|
@@ -3391,7 +3391,11 @@ function requireFactory$2 () {
|
|
|
3391
3391
|
return this.wrapSync({ uuid, name: options.name });
|
|
3392
3392
|
}
|
|
3393
3393
|
/**
|
|
3394
|
-
* Asynchronously returns
|
|
3394
|
+
* Asynchronously returns an API handle for the given View identity.
|
|
3395
|
+
*
|
|
3396
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
3397
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
3398
|
+
* for a View throughout its entire lifecycle.
|
|
3395
3399
|
*
|
|
3396
3400
|
* @example
|
|
3397
3401
|
* ```js
|
|
@@ -3410,7 +3414,11 @@ function requireFactory$2 () {
|
|
|
3410
3414
|
return new index_1.View(this.wire, identity);
|
|
3411
3415
|
}
|
|
3412
3416
|
/**
|
|
3413
|
-
* Synchronously returns
|
|
3417
|
+
* Synchronously returns an API handle for the given View identity.
|
|
3418
|
+
*
|
|
3419
|
+
* @remarks Wrapping a View identity that does not yet exist will *not* throw an error, and instead
|
|
3420
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
3421
|
+
* for a View throughout its entire lifecycle.
|
|
3414
3422
|
*
|
|
3415
3423
|
* @example
|
|
3416
3424
|
* ```js
|
|
@@ -6109,7 +6117,11 @@ function requireFactory$1 () {
|
|
|
6109
6117
|
*/
|
|
6110
6118
|
class ApplicationModule extends base_1.Base {
|
|
6111
6119
|
/**
|
|
6112
|
-
* Asynchronously returns an
|
|
6120
|
+
* Asynchronously returns an API handle for the given Application identity.
|
|
6121
|
+
*
|
|
6122
|
+
* @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
|
|
6123
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
6124
|
+
* for an Application throughout its entire lifecycle.
|
|
6113
6125
|
*
|
|
6114
6126
|
* @example
|
|
6115
6127
|
*
|
|
@@ -6132,7 +6144,11 @@ function requireFactory$1 () {
|
|
|
6132
6144
|
return new Instance_1.Application(this.wire, identity);
|
|
6133
6145
|
}
|
|
6134
6146
|
/**
|
|
6135
|
-
* Synchronously returns an
|
|
6147
|
+
* Synchronously returns an API handle for the given Application identity.
|
|
6148
|
+
*
|
|
6149
|
+
* @remarks Wrapping an Application identity that does not yet exist will *not* throw an error, and instead
|
|
6150
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
6151
|
+
* for an Aplication throughout its entire lifecycle.
|
|
6136
6152
|
*
|
|
6137
6153
|
* @example
|
|
6138
6154
|
*
|
|
@@ -7697,7 +7713,11 @@ function requireFactory () {
|
|
|
7697
7713
|
*/
|
|
7698
7714
|
class _WindowModule extends base_1.Base {
|
|
7699
7715
|
/**
|
|
7700
|
-
* Asynchronously returns
|
|
7716
|
+
* Asynchronously returns an API handle for the given Window identity.
|
|
7717
|
+
*
|
|
7718
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
7719
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
7720
|
+
* for a Window throughout its entire lifecycle.
|
|
7701
7721
|
*
|
|
7702
7722
|
* @example
|
|
7703
7723
|
* ```js
|
|
@@ -7726,7 +7746,11 @@ function requireFactory () {
|
|
|
7726
7746
|
return new Instance_1._Window(this.wire, identity);
|
|
7727
7747
|
}
|
|
7728
7748
|
/**
|
|
7729
|
-
* Synchronously returns
|
|
7749
|
+
* Synchronously returns an API handle for the given Window identity.
|
|
7750
|
+
*
|
|
7751
|
+
* @remarks Wrapping a Window identity that does not yet exist will *not* throw an error, and instead
|
|
7752
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
7753
|
+
* for a Window throughout its entire lifecycle.
|
|
7730
7754
|
*
|
|
7731
7755
|
* @example
|
|
7732
7756
|
* ```js
|
|
@@ -8530,6 +8554,8 @@ class _Frame extends base_1$h.EmitterBase {
|
|
|
8530
8554
|
* Returns a frame info object representing the window that the referenced iframe is
|
|
8531
8555
|
* currently embedded in.
|
|
8532
8556
|
*
|
|
8557
|
+
* @remarks If the frame is embedded in a view, this will return an invalid stub with empty fields.
|
|
8558
|
+
*
|
|
8533
8559
|
* @example
|
|
8534
8560
|
* ```js
|
|
8535
8561
|
* async function getParentWindow() {
|
|
@@ -8555,8 +8581,11 @@ const Instance_1$4 = Instance$4;
|
|
|
8555
8581
|
*/
|
|
8556
8582
|
class _FrameModule extends base_1$g.Base {
|
|
8557
8583
|
/**
|
|
8558
|
-
* Asynchronously returns
|
|
8559
|
-
*
|
|
8584
|
+
* Asynchronously returns an API handle for the given Frame identity.
|
|
8585
|
+
*
|
|
8586
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
8587
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
8588
|
+
* for a Frame throughout its entire lifecycle.
|
|
8560
8589
|
*
|
|
8561
8590
|
* @example
|
|
8562
8591
|
* ```js
|
|
@@ -8576,8 +8605,11 @@ class _FrameModule extends base_1$g.Base {
|
|
|
8576
8605
|
return new Instance_1$4._Frame(this.wire, identity);
|
|
8577
8606
|
}
|
|
8578
8607
|
/**
|
|
8579
|
-
* Synchronously returns
|
|
8580
|
-
*
|
|
8608
|
+
* Synchronously returns an API handle for the given Frame identity.
|
|
8609
|
+
*
|
|
8610
|
+
* @remarks Wrapping a Frame identity that does not yet exist will *not* throw an error, and instead
|
|
8611
|
+
* returns a stub object that cannot yet perform rendering tasks. This can be useful for plumbing eventing
|
|
8612
|
+
* for a Frame throughout its entire lifecycle.
|
|
8581
8613
|
*
|
|
8582
8614
|
* @example
|
|
8583
8615
|
* ```js
|