@openfin/node-adapter 38.81.29 → 38.81.30
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.
@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
825
825
|
*/
|
826
826
|
showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
|
827
827
|
/**
|
828
|
-
*
|
828
|
+
* Closes the tray icon menu.
|
829
829
|
*
|
830
830
|
* @throws if the application has no tray icon set
|
831
831
|
* @example
|
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
|
|
934
934
|
* @interface
|
935
935
|
*/
|
936
936
|
declare type ApplicationInfo = {
|
937
|
-
initialOptions: ApplicationCreationOptions | PlatformOptions;
|
937
|
+
initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
|
938
938
|
launchMode: string;
|
939
939
|
manifest: Manifest & {
|
940
940
|
[key: string]: any;
|
@@ -9909,6 +9909,7 @@ declare namespace OpenFin {
|
|
9909
9909
|
AppVersionError,
|
9910
9910
|
AppVersionRuntimeInfo,
|
9911
9911
|
LaunchEmitter,
|
9912
|
+
UserAppConfigArgs,
|
9912
9913
|
RvmLaunchOptions,
|
9913
9914
|
ShortCutConfig,
|
9914
9915
|
TerminateExternalRequestType,
|
@@ -12735,7 +12736,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
12735
12736
|
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
12736
12737
|
topic: 'application';
|
12737
12738
|
type: 'run-requested';
|
12738
|
-
userAppConfigArgs:
|
12739
|
+
userAppConfigArgs: OpenFin.UserAppConfigArgs;
|
12739
12740
|
manifest: OpenFin.Manifest;
|
12740
12741
|
};
|
12741
12742
|
|
@@ -12850,7 +12851,7 @@ declare type RvmLaunchOptions = {
|
|
12850
12851
|
* True if no UI when launching
|
12851
12852
|
*/
|
12852
12853
|
noUi?: boolean;
|
12853
|
-
userAppConfigArgs?:
|
12854
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
12854
12855
|
/**
|
12855
12856
|
* Timeout in seconds until RVM launch request expires.
|
12856
12857
|
*/
|
@@ -15379,6 +15380,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15379
15380
|
httpStatusText: string;
|
15380
15381
|
});
|
15381
15382
|
|
15383
|
+
/**
|
15384
|
+
* @interface
|
15385
|
+
*/
|
15386
|
+
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
15387
|
+
|
15382
15388
|
/**
|
15383
15389
|
* A general user bounds change event without event type.
|
15384
15390
|
* @interface
|
@@ -18785,6 +18791,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
18785
18791
|
positioningOptions?: OpenFin.PositioningOptions;
|
18786
18792
|
};
|
18787
18793
|
|
18794
|
+
declare type WithUserAppConfigArgs = {
|
18795
|
+
/**
|
18796
|
+
* Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
|
18797
|
+
* that launches this application.
|
18798
|
+
*
|
18799
|
+
* @remarks
|
18800
|
+
* In the link, user defined parameters are separated by the `$$` delimeter, for example:
|
18801
|
+
* `fins://path.to/app/manifest.json?$$use-last-configuration=true`
|
18802
|
+
*
|
18803
|
+
* Results in the following object:
|
18804
|
+
* ```json
|
18805
|
+
* {
|
18806
|
+
* "use-last-configuration": true"
|
18807
|
+
* }
|
18808
|
+
* ```
|
18809
|
+
*
|
18810
|
+
* These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
|
18811
|
+
* ```typescript
|
18812
|
+
* const appInfo = await fin.Application.getCurrentSync().getInfo();
|
18813
|
+
* const { userAppConfigArgs } = appInfo.initialOptions;
|
18814
|
+
* console.log(userAppConfigArgs['use-last-configuration']); // 'true'
|
18815
|
+
* ```
|
18816
|
+
*/
|
18817
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
18818
|
+
};
|
18819
|
+
|
18788
18820
|
/* Excluded from this release type: WorkspacePlatformOptions */
|
18789
18821
|
|
18790
18822
|
/**
|
@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
825
825
|
*/
|
826
826
|
showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
|
827
827
|
/**
|
828
|
-
*
|
828
|
+
* Closes the tray icon menu.
|
829
829
|
*
|
830
830
|
* @throws if the application has no tray icon set
|
831
831
|
* @example
|
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
|
|
934
934
|
* @interface
|
935
935
|
*/
|
936
936
|
declare type ApplicationInfo = {
|
937
|
-
initialOptions: ApplicationCreationOptions | PlatformOptions;
|
937
|
+
initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
|
938
938
|
launchMode: string;
|
939
939
|
manifest: Manifest & {
|
940
940
|
[key: string]: any;
|
@@ -9909,6 +9909,7 @@ declare namespace OpenFin {
|
|
9909
9909
|
AppVersionError,
|
9910
9910
|
AppVersionRuntimeInfo,
|
9911
9911
|
LaunchEmitter,
|
9912
|
+
UserAppConfigArgs,
|
9912
9913
|
RvmLaunchOptions,
|
9913
9914
|
ShortCutConfig,
|
9914
9915
|
TerminateExternalRequestType,
|
@@ -12735,7 +12736,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
12735
12736
|
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
12736
12737
|
topic: 'application';
|
12737
12738
|
type: 'run-requested';
|
12738
|
-
userAppConfigArgs:
|
12739
|
+
userAppConfigArgs: OpenFin.UserAppConfigArgs;
|
12739
12740
|
manifest: OpenFin.Manifest;
|
12740
12741
|
};
|
12741
12742
|
|
@@ -12850,7 +12851,7 @@ declare type RvmLaunchOptions = {
|
|
12850
12851
|
* True if no UI when launching
|
12851
12852
|
*/
|
12852
12853
|
noUi?: boolean;
|
12853
|
-
userAppConfigArgs?:
|
12854
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
12854
12855
|
/**
|
12855
12856
|
* Timeout in seconds until RVM launch request expires.
|
12856
12857
|
*/
|
@@ -15379,6 +15380,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15379
15380
|
httpStatusText: string;
|
15380
15381
|
});
|
15381
15382
|
|
15383
|
+
/**
|
15384
|
+
* @interface
|
15385
|
+
*/
|
15386
|
+
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
15387
|
+
|
15382
15388
|
/**
|
15383
15389
|
* A general user bounds change event without event type.
|
15384
15390
|
* @interface
|
@@ -18785,6 +18791,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
18785
18791
|
positioningOptions?: OpenFin.PositioningOptions;
|
18786
18792
|
};
|
18787
18793
|
|
18794
|
+
declare type WithUserAppConfigArgs = {
|
18795
|
+
/**
|
18796
|
+
* Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
|
18797
|
+
* that launches this application.
|
18798
|
+
*
|
18799
|
+
* @remarks
|
18800
|
+
* In the link, user defined parameters are separated by the `$$` delimeter, for example:
|
18801
|
+
* `fins://path.to/app/manifest.json?$$use-last-configuration=true`
|
18802
|
+
*
|
18803
|
+
* Results in the following object:
|
18804
|
+
* ```json
|
18805
|
+
* {
|
18806
|
+
* "use-last-configuration": true"
|
18807
|
+
* }
|
18808
|
+
* ```
|
18809
|
+
*
|
18810
|
+
* These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
|
18811
|
+
* ```typescript
|
18812
|
+
* const appInfo = await fin.Application.getCurrentSync().getInfo();
|
18813
|
+
* const { userAppConfigArgs } = appInfo.initialOptions;
|
18814
|
+
* console.log(userAppConfigArgs['use-last-configuration']); // 'true'
|
18815
|
+
* ```
|
18816
|
+
*/
|
18817
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
18818
|
+
};
|
18819
|
+
|
18788
18820
|
/* Excluded from this release type: WorkspacePlatformOptions */
|
18789
18821
|
|
18790
18822
|
/**
|
@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
825
825
|
*/
|
826
826
|
showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
|
827
827
|
/**
|
828
|
-
*
|
828
|
+
* Closes the tray icon menu.
|
829
829
|
*
|
830
830
|
* @throws if the application has no tray icon set
|
831
831
|
* @example
|
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
|
|
934
934
|
* @interface
|
935
935
|
*/
|
936
936
|
declare type ApplicationInfo = {
|
937
|
-
initialOptions: ApplicationCreationOptions | PlatformOptions;
|
937
|
+
initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
|
938
938
|
launchMode: string;
|
939
939
|
manifest: Manifest & {
|
940
940
|
[key: string]: any;
|
@@ -9909,6 +9909,7 @@ declare namespace OpenFin {
|
|
9909
9909
|
AppVersionError,
|
9910
9910
|
AppVersionRuntimeInfo,
|
9911
9911
|
LaunchEmitter,
|
9912
|
+
UserAppConfigArgs,
|
9912
9913
|
RvmLaunchOptions,
|
9913
9914
|
ShortCutConfig,
|
9914
9915
|
TerminateExternalRequestType,
|
@@ -12735,7 +12736,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
12735
12736
|
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
12736
12737
|
topic: 'application';
|
12737
12738
|
type: 'run-requested';
|
12738
|
-
userAppConfigArgs:
|
12739
|
+
userAppConfigArgs: OpenFin.UserAppConfigArgs;
|
12739
12740
|
manifest: OpenFin.Manifest;
|
12740
12741
|
};
|
12741
12742
|
|
@@ -12850,7 +12851,7 @@ declare type RvmLaunchOptions = {
|
|
12850
12851
|
* True if no UI when launching
|
12851
12852
|
*/
|
12852
12853
|
noUi?: boolean;
|
12853
|
-
userAppConfigArgs?:
|
12854
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
12854
12855
|
/**
|
12855
12856
|
* Timeout in seconds until RVM launch request expires.
|
12856
12857
|
*/
|
@@ -15379,6 +15380,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15379
15380
|
httpStatusText: string;
|
15380
15381
|
});
|
15381
15382
|
|
15383
|
+
/**
|
15384
|
+
* @interface
|
15385
|
+
*/
|
15386
|
+
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
15387
|
+
|
15382
15388
|
/**
|
15383
15389
|
* A general user bounds change event without event type.
|
15384
15390
|
* @interface
|
@@ -18785,6 +18791,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
18785
18791
|
positioningOptions?: OpenFin.PositioningOptions;
|
18786
18792
|
};
|
18787
18793
|
|
18794
|
+
declare type WithUserAppConfigArgs = {
|
18795
|
+
/**
|
18796
|
+
* Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
|
18797
|
+
* that launches this application.
|
18798
|
+
*
|
18799
|
+
* @remarks
|
18800
|
+
* In the link, user defined parameters are separated by the `$$` delimeter, for example:
|
18801
|
+
* `fins://path.to/app/manifest.json?$$use-last-configuration=true`
|
18802
|
+
*
|
18803
|
+
* Results in the following object:
|
18804
|
+
* ```json
|
18805
|
+
* {
|
18806
|
+
* "use-last-configuration": true"
|
18807
|
+
* }
|
18808
|
+
* ```
|
18809
|
+
*
|
18810
|
+
* These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
|
18811
|
+
* ```typescript
|
18812
|
+
* const appInfo = await fin.Application.getCurrentSync().getInfo();
|
18813
|
+
* const { userAppConfigArgs } = appInfo.initialOptions;
|
18814
|
+
* console.log(userAppConfigArgs['use-last-configuration']); // 'true'
|
18815
|
+
* ```
|
18816
|
+
*/
|
18817
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
18818
|
+
};
|
18819
|
+
|
18788
18820
|
/* Excluded from this release type: WorkspacePlatformOptions */
|
18789
18821
|
|
18790
18822
|
/**
|
package/out/node-adapter.d.ts
CHANGED
@@ -831,7 +831,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
|
|
831
831
|
*/
|
832
832
|
showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
|
833
833
|
/**
|
834
|
-
*
|
834
|
+
* Closes the tray icon menu.
|
835
835
|
*
|
836
836
|
* @throws if the application has no tray icon set
|
837
837
|
* @example
|
@@ -940,7 +940,7 @@ declare type ApplicationIdentity_2 = {
|
|
940
940
|
* @interface
|
941
941
|
*/
|
942
942
|
declare type ApplicationInfo = {
|
943
|
-
initialOptions: ApplicationCreationOptions | PlatformOptions;
|
943
|
+
initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
|
944
944
|
launchMode: string;
|
945
945
|
manifest: Manifest & {
|
946
946
|
[key: string]: any;
|
@@ -10246,6 +10246,7 @@ declare namespace OpenFin {
|
|
10246
10246
|
AppVersionError,
|
10247
10247
|
AppVersionRuntimeInfo,
|
10248
10248
|
LaunchEmitter,
|
10249
|
+
UserAppConfigArgs,
|
10249
10250
|
RvmLaunchOptions,
|
10250
10251
|
ShortCutConfig,
|
10251
10252
|
TerminateExternalRequestType,
|
@@ -13150,7 +13151,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
|
|
13150
13151
|
declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
|
13151
13152
|
topic: 'application';
|
13152
13153
|
type: 'run-requested';
|
13153
|
-
userAppConfigArgs:
|
13154
|
+
userAppConfigArgs: OpenFin.UserAppConfigArgs;
|
13154
13155
|
manifest: OpenFin.Manifest;
|
13155
13156
|
};
|
13156
13157
|
|
@@ -13265,7 +13266,7 @@ declare type RvmLaunchOptions = {
|
|
13265
13266
|
* True if no UI when launching
|
13266
13267
|
*/
|
13267
13268
|
noUi?: boolean;
|
13268
|
-
userAppConfigArgs?:
|
13269
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
13269
13270
|
/**
|
13270
13271
|
* Timeout in seconds until RVM launch request expires.
|
13271
13272
|
*/
|
@@ -15807,6 +15808,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
15807
15808
|
httpStatusText: string;
|
15808
15809
|
});
|
15809
15810
|
|
15811
|
+
/**
|
15812
|
+
* @interface
|
15813
|
+
*/
|
15814
|
+
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
15815
|
+
|
15810
15816
|
/**
|
15811
15817
|
* A general user bounds change event without event type.
|
15812
15818
|
* @interface
|
@@ -19259,6 +19265,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
|
|
19259
19265
|
positioningOptions?: OpenFin.PositioningOptions;
|
19260
19266
|
};
|
19261
19267
|
|
19268
|
+
declare type WithUserAppConfigArgs = {
|
19269
|
+
/**
|
19270
|
+
* Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
|
19271
|
+
* that launches this application.
|
19272
|
+
*
|
19273
|
+
* @remarks
|
19274
|
+
* In the link, user defined parameters are separated by the `$$` delimeter, for example:
|
19275
|
+
* `fins://path.to/app/manifest.json?$$use-last-configuration=true`
|
19276
|
+
*
|
19277
|
+
* Results in the following object:
|
19278
|
+
* ```json
|
19279
|
+
* {
|
19280
|
+
* "use-last-configuration": true"
|
19281
|
+
* }
|
19282
|
+
* ```
|
19283
|
+
*
|
19284
|
+
* These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
|
19285
|
+
* ```typescript
|
19286
|
+
* const appInfo = await fin.Application.getCurrentSync().getInfo();
|
19287
|
+
* const { userAppConfigArgs } = appInfo.initialOptions;
|
19288
|
+
* console.log(userAppConfigArgs['use-last-configuration']); // 'true'
|
19289
|
+
* ```
|
19290
|
+
*/
|
19291
|
+
userAppConfigArgs?: UserAppConfigArgs;
|
19292
|
+
};
|
19293
|
+
|
19262
19294
|
/**
|
19263
19295
|
* @internal
|
19264
19296
|
* @interface
|
package/out/node-adapter.js
CHANGED