@openfin/fdc3-api 38.82.69 → 38.83.71
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/fdc3-api-alpha.d.ts +941 -221
- package/out/fdc3-api-beta.d.ts +941 -221
- package/out/fdc3-api-public.d.ts +941 -221
- package/out/fdc3-api.d.ts +941 -221
- package/out/fdc3-api.js +39 -7
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -58,7 +58,7 @@ declare type AddedToLayoutEvent = BaseEvent_4 & {
|
|
|
58
58
|
*/
|
|
59
59
|
declare type AddViewOptions = CreateViewTarget & {
|
|
60
60
|
options: ViewState;
|
|
61
|
-
targetView?:
|
|
61
|
+
targetView?: Identity_4;
|
|
62
62
|
};
|
|
63
63
|
|
|
64
64
|
/**
|
|
@@ -930,15 +930,15 @@ declare namespace ApplicationEvents {
|
|
|
930
930
|
*/
|
|
931
931
|
declare type ApplicationEventType = EventType_3;
|
|
932
932
|
|
|
933
|
-
declare type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
|
934
|
-
|
|
935
933
|
/**
|
|
936
934
|
* @interface
|
|
937
935
|
*/
|
|
938
|
-
declare type
|
|
936
|
+
declare type ApplicationIdentity = {
|
|
939
937
|
uuid: string;
|
|
940
938
|
};
|
|
941
939
|
|
|
940
|
+
declare type ApplicationIdentityCall<AdditionalPayload = {}, Response = void> = ApiCall<AdditionalPayload & OpenFin.ApplicationIdentity, Response>;
|
|
941
|
+
|
|
942
942
|
/**
|
|
943
943
|
* @interface
|
|
944
944
|
*/
|
|
@@ -1311,12 +1311,10 @@ declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedE
|
|
|
1311
1311
|
*/
|
|
1312
1312
|
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
|
1313
1313
|
|
|
1314
|
-
declare type ApplicationState = OpenFin.ApplicationState;
|
|
1315
|
-
|
|
1316
1314
|
/**
|
|
1317
1315
|
* @interface
|
|
1318
1316
|
*/
|
|
1319
|
-
declare type
|
|
1317
|
+
declare type ApplicationState = {
|
|
1320
1318
|
/**
|
|
1321
1319
|
* True when the application is a Platform controller
|
|
1322
1320
|
*/
|
|
@@ -1348,12 +1346,10 @@ declare type ApplicationType = {
|
|
|
1348
1346
|
*/
|
|
1349
1347
|
declare type ApplicationWindowEvent = WindowAlertRequestedEvent | WindowCreatedEvent | WindowEndLoadEvent | WindowNotRespondingEvent | WindowRespondingEvent | WindowStartLoadEvent;
|
|
1350
1348
|
|
|
1351
|
-
declare type ApplicationWindowInfo = OpenFin.ApplicationWindowInfo;
|
|
1352
|
-
|
|
1353
1349
|
/**
|
|
1354
1350
|
* @interface
|
|
1355
1351
|
*/
|
|
1356
|
-
declare type
|
|
1352
|
+
declare type ApplicationWindowInfo = {
|
|
1357
1353
|
childWindows: Array<WindowDetail>;
|
|
1358
1354
|
mainWindow: WindowDetail;
|
|
1359
1355
|
/**
|
|
@@ -1618,7 +1614,7 @@ declare class Base {
|
|
|
1618
1614
|
* Useful for debugging in the devtools console, where this will intelligently type itself based
|
|
1619
1615
|
* on the context in which the devtools panel was opened.
|
|
1620
1616
|
*/
|
|
1621
|
-
get me(): Identity;
|
|
1617
|
+
get me(): OpenFin.Identity;
|
|
1622
1618
|
/* Excluded from this release type: isNodeEnvironment */
|
|
1623
1619
|
/* Excluded from this release type: isOpenFinEnvironment */
|
|
1624
1620
|
/* Excluded from this release type: isBrowserEnvironment */
|
|
@@ -1838,11 +1834,12 @@ declare type BeforeUnloadUserDecision = {
|
|
|
1838
1834
|
/**
|
|
1839
1835
|
* Array of views that will close.
|
|
1840
1836
|
*/
|
|
1841
|
-
viewsToClose:
|
|
1837
|
+
viewsToClose: Identity_4[];
|
|
1842
1838
|
};
|
|
1843
1839
|
|
|
1844
1840
|
/**
|
|
1845
1841
|
* Generated at the beginning of a user-driven change to a window's size or position.
|
|
1842
|
+
*
|
|
1846
1843
|
* @interface
|
|
1847
1844
|
*/
|
|
1848
1845
|
declare type BeginUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
@@ -1883,31 +1880,33 @@ declare type Bounds = {
|
|
|
1883
1880
|
* Generated after changes in a window's size and/or position.
|
|
1884
1881
|
* @interface
|
|
1885
1882
|
*/
|
|
1886
|
-
declare type BoundsChangedEvent =
|
|
1883
|
+
declare type BoundsChangedEvent = BoundsDidChangeEvent & {
|
|
1887
1884
|
type: 'bounds-changed';
|
|
1888
1885
|
};
|
|
1889
1886
|
|
|
1890
|
-
|
|
1891
|
-
* A general bounds change event without event type.
|
|
1892
|
-
* @interface
|
|
1893
|
-
*/
|
|
1894
|
-
declare type BoundsChangeEvent = BaseEvent_5 & {
|
|
1887
|
+
declare type BoundsChangeEvent = BoundsEvent & {
|
|
1895
1888
|
changeType: 0 | 1 | 2;
|
|
1896
|
-
deferred: boolean;
|
|
1897
|
-
height: number;
|
|
1898
|
-
left: number;
|
|
1899
|
-
top: number;
|
|
1900
|
-
width: number;
|
|
1901
1889
|
};
|
|
1902
1890
|
|
|
1903
1891
|
/**
|
|
1904
1892
|
* Generated during changes to a window's size and/or position.
|
|
1905
1893
|
* @interface
|
|
1906
1894
|
*/
|
|
1907
|
-
declare type BoundsChangingEvent =
|
|
1895
|
+
declare type BoundsChangingEvent = BoundsDidChangeEvent & {
|
|
1908
1896
|
type: 'bounds-changing';
|
|
1909
1897
|
};
|
|
1910
1898
|
|
|
1899
|
+
/**
|
|
1900
|
+
* An event that fires when a window's bounds are successfully changed.
|
|
1901
|
+
*
|
|
1902
|
+
* @interface
|
|
1903
|
+
*/
|
|
1904
|
+
declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
1905
|
+
reason: 'self' | 'animation';
|
|
1906
|
+
};
|
|
1907
|
+
|
|
1908
|
+
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1909
|
+
|
|
1911
1910
|
/**
|
|
1912
1911
|
* A rule prescribing content creation in the browser.
|
|
1913
1912
|
*
|
|
@@ -2941,6 +2940,18 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
2941
2940
|
childOptions: OpenFin.WindowOptions;
|
|
2942
2941
|
};
|
|
2943
2942
|
|
|
2943
|
+
/**
|
|
2944
|
+
* Control behavior for Chromium policies
|
|
2945
|
+
*
|
|
2946
|
+
* @interface
|
|
2947
|
+
*/
|
|
2948
|
+
declare type ChromiumPolicies = {
|
|
2949
|
+
/**
|
|
2950
|
+
* Disable AutofillAddressEnabled policy for a Window or View.
|
|
2951
|
+
*/
|
|
2952
|
+
AutofillAddressEnabled?: PolicyOptions;
|
|
2953
|
+
};
|
|
2954
|
+
|
|
2944
2955
|
declare interface ClassicProtocolOffer extends ProtocolPacketBase {
|
|
2945
2956
|
type: 'classic';
|
|
2946
2957
|
}
|
|
@@ -2989,7 +3000,7 @@ declare type ClientConnectionPayload = ClientIdentity & ClientInfo;
|
|
|
2989
3000
|
* Identity of a channel client. Includes endpointId to differentiate between different connections for an entity.
|
|
2990
3001
|
* @interface
|
|
2991
3002
|
*/
|
|
2992
|
-
declare type ClientIdentity =
|
|
3003
|
+
declare type ClientIdentity = Identity_4 & {
|
|
2993
3004
|
/**
|
|
2994
3005
|
* Unique identifier for a client, because there can be multiple clients at one name/uuid entity.
|
|
2995
3006
|
*/
|
|
@@ -3222,7 +3233,7 @@ declare type CloseViewOptions = {
|
|
|
3222
3233
|
/**
|
|
3223
3234
|
*View to be closed.
|
|
3224
3235
|
*/
|
|
3225
|
-
viewIdentity:
|
|
3236
|
+
viewIdentity: Identity_4;
|
|
3226
3237
|
};
|
|
3227
3238
|
|
|
3228
3239
|
/**
|
|
@@ -3232,7 +3243,7 @@ declare type CloseViewPayload = {
|
|
|
3232
3243
|
/**
|
|
3233
3244
|
*View to be closed.
|
|
3234
3245
|
*/
|
|
3235
|
-
view:
|
|
3246
|
+
view: Identity_4;
|
|
3236
3247
|
/**
|
|
3237
3248
|
* The target layout identity where this view should be closed. If not provided, will resolve to the
|
|
3238
3249
|
* visible layout.
|
|
@@ -3250,7 +3261,7 @@ declare interface CloseWindowPayload {
|
|
|
3250
3261
|
*
|
|
3251
3262
|
* Identity of the Window
|
|
3252
3263
|
*/
|
|
3253
|
-
windowId:
|
|
3264
|
+
windowId: Identity_4;
|
|
3254
3265
|
options: {
|
|
3255
3266
|
/**
|
|
3256
3267
|
* @defaultValue false
|
|
@@ -3368,7 +3379,7 @@ declare type ConstViewOptions = {
|
|
|
3368
3379
|
/**
|
|
3369
3380
|
* The identity of the window this view should be attached to.
|
|
3370
3381
|
*/
|
|
3371
|
-
target:
|
|
3382
|
+
target: Identity_4;
|
|
3372
3383
|
/**
|
|
3373
3384
|
* Configures how new content (e,g, from `window.open` or a link) is opened.
|
|
3374
3385
|
*/
|
|
@@ -3452,6 +3463,10 @@ declare type ConstViewOptions = {
|
|
|
3452
3463
|
*/
|
|
3453
3464
|
enabled: boolean;
|
|
3454
3465
|
};
|
|
3466
|
+
/**
|
|
3467
|
+
* Control which options to ignore when creating a Platform View.
|
|
3468
|
+
*/
|
|
3469
|
+
excludeOptions: ExcludeOptions;
|
|
3455
3470
|
};
|
|
3456
3471
|
|
|
3457
3472
|
/**
|
|
@@ -3593,7 +3608,7 @@ declare type ConstWindowOptions = {
|
|
|
3593
3608
|
/**
|
|
3594
3609
|
* Parent identity of a modal window. It will create a modal child window when this option is set.
|
|
3595
3610
|
*/
|
|
3596
|
-
modalParentIdentity:
|
|
3611
|
+
modalParentIdentity: Identity_4;
|
|
3597
3612
|
/**
|
|
3598
3613
|
* The name of the window.
|
|
3599
3614
|
*/
|
|
@@ -3611,7 +3626,9 @@ declare type ConstWindowOptions = {
|
|
|
3611
3626
|
*/
|
|
3612
3627
|
preloadScripts: PreloadScript[];
|
|
3613
3628
|
/**
|
|
3614
|
-
* String tag that attempts to group like-tagged renderers together.
|
|
3629
|
+
* String tag that attempts to group like-tagged renderers together.
|
|
3630
|
+
* However, there is no guarantee that a different affinity value will create a different process, under the hood Chromium can enforce its own process management under certain circumstances.
|
|
3631
|
+
* @remarks Will only be used if pages are on the same origin.
|
|
3615
3632
|
*/
|
|
3616
3633
|
processAffinity: string;
|
|
3617
3634
|
/**
|
|
@@ -3658,11 +3675,6 @@ declare type ConstWindowOptions = {
|
|
|
3658
3675
|
* @deprecated - use `icon` instead.
|
|
3659
3676
|
*/
|
|
3660
3677
|
taskbarIcon: string;
|
|
3661
|
-
/**
|
|
3662
|
-
* Specify a taskbar group for the window.
|
|
3663
|
-
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
3664
|
-
*/
|
|
3665
|
-
taskbarIconGroup: string;
|
|
3666
3678
|
/**
|
|
3667
3679
|
* @defaultValue "about:blank"
|
|
3668
3680
|
*
|
|
@@ -3699,6 +3711,10 @@ declare type ConstWindowOptions = {
|
|
|
3699
3711
|
* 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.
|
|
3700
3712
|
*/
|
|
3701
3713
|
inheritance?: Partial<InheritableOptions>;
|
|
3714
|
+
/**
|
|
3715
|
+
* Control which options to ignore when creating a Platform Window.
|
|
3716
|
+
*/
|
|
3717
|
+
excludeOptions: ExcludeOptions;
|
|
3702
3718
|
};
|
|
3703
3719
|
|
|
3704
3720
|
/**
|
|
@@ -4077,13 +4093,13 @@ declare type CreateViewPayload = {
|
|
|
4077
4093
|
* Window the view will be added to. If no target is provided, a new window will be created.
|
|
4078
4094
|
*/
|
|
4079
4095
|
target?: CreateViewTarget;
|
|
4080
|
-
targetView?:
|
|
4096
|
+
targetView?: Identity_4;
|
|
4081
4097
|
};
|
|
4082
4098
|
|
|
4083
4099
|
/**
|
|
4084
4100
|
* @interface
|
|
4085
4101
|
*/
|
|
4086
|
-
declare type CreateViewTarget = (
|
|
4102
|
+
declare type CreateViewTarget = (Identity_4 | LayoutIdentity) & {
|
|
4087
4103
|
/**
|
|
4088
4104
|
* If specified, view creation will not attach to a window and caller must
|
|
4089
4105
|
* insert the view into the layout explicitly
|
|
@@ -4529,7 +4545,7 @@ declare type EmitterAccessor = string[];
|
|
|
4529
4545
|
declare class EmitterBase<EmitterEvent extends BaseEvent, EmitterEventType extends EmitterEvent['type'] = EmitterEvent['type']> extends Base {
|
|
4530
4546
|
#private;
|
|
4531
4547
|
private topic;
|
|
4532
|
-
protected identity: ApplicationIdentity;
|
|
4548
|
+
protected identity: OpenFin.ApplicationIdentity;
|
|
4533
4549
|
constructor(wire: Transport, topic: string, ...additionalAccessors: string[]);
|
|
4534
4550
|
eventNames: () => (string | symbol)[];
|
|
4535
4551
|
/* Excluded from this release type: emit */
|
|
@@ -4604,20 +4620,17 @@ declare type EndLoadEvent = BaseEvent_5 & {
|
|
|
4604
4620
|
|
|
4605
4621
|
/**
|
|
4606
4622
|
* Generated at the end of a user-driven change to a window's size or position.
|
|
4623
|
+
*
|
|
4607
4624
|
* @interface
|
|
4608
4625
|
*/
|
|
4609
4626
|
declare type EndUserBoundsChangingEvent = UserBoundsChangeEvent & {
|
|
4610
4627
|
type: 'end-user-bounds-changing';
|
|
4611
4628
|
};
|
|
4612
4629
|
|
|
4613
|
-
declare type Entity = OpenFin.ApplicationType;
|
|
4614
|
-
|
|
4615
|
-
declare type EntityInfo = OpenFin.EntityInfo;
|
|
4616
|
-
|
|
4617
4630
|
/**
|
|
4618
4631
|
* @interface
|
|
4619
4632
|
*/
|
|
4620
|
-
declare type
|
|
4633
|
+
declare type EntityInfo = {
|
|
4621
4634
|
uuid: string;
|
|
4622
4635
|
name: string;
|
|
4623
4636
|
entityType: EntityType_4;
|
|
@@ -4735,7 +4748,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
|
|
|
4735
4748
|
* under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
|
|
4736
4749
|
* from which they propagate).
|
|
4737
4750
|
*/
|
|
4738
|
-
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
|
|
4751
|
+
declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
|
|
4739
4752
|
|
|
4740
4753
|
/**
|
|
4741
4754
|
* [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
|
|
@@ -4880,6 +4893,18 @@ declare type EventType_9 = Event_12['type'];
|
|
|
4880
4893
|
|
|
4881
4894
|
/* Excluded from this release type: EventWithId */
|
|
4882
4895
|
|
|
4896
|
+
/**
|
|
4897
|
+
* @interface
|
|
4898
|
+
*/
|
|
4899
|
+
declare type ExcludeOptions = {
|
|
4900
|
+
/**
|
|
4901
|
+
* @defaultValue false
|
|
4902
|
+
*
|
|
4903
|
+
* When true, will not merge default preload scripts from {@link ApplicationOptions.defaultWindowOptions} or {@link ApplicationOptions.defaultViewOptions}.
|
|
4904
|
+
*/
|
|
4905
|
+
preloadScripts: boolean;
|
|
4906
|
+
};
|
|
4907
|
+
|
|
4883
4908
|
/* Excluded from this release type: ExcludeRequested */
|
|
4884
4909
|
|
|
4885
4910
|
declare type ExistingConnectConfig = ConfigWithUuid & {
|
|
@@ -4895,6 +4920,105 @@ declare type ExitCode = {
|
|
|
4895
4920
|
exitCode: number;
|
|
4896
4921
|
};
|
|
4897
4922
|
|
|
4923
|
+
declare type ExtensionEvent = SecurityRealmEvent & {
|
|
4924
|
+
/**
|
|
4925
|
+
* Runtime extension whose status has been (possibly) modified
|
|
4926
|
+
*/
|
|
4927
|
+
extension: string;
|
|
4928
|
+
};
|
|
4929
|
+
|
|
4930
|
+
/**
|
|
4931
|
+
* @interface
|
|
4932
|
+
*/
|
|
4933
|
+
declare type ExtensionInfo = {
|
|
4934
|
+
extensionId: string;
|
|
4935
|
+
name: string;
|
|
4936
|
+
enabled: boolean;
|
|
4937
|
+
};
|
|
4938
|
+
|
|
4939
|
+
/**
|
|
4940
|
+
* An event that fires when an extension is installed in the security realm.
|
|
4941
|
+
*
|
|
4942
|
+
* @interface
|
|
4943
|
+
*/
|
|
4944
|
+
declare type ExtensionInstalledEvent = ExtensionEvent & {
|
|
4945
|
+
type: 'extension-installed';
|
|
4946
|
+
};
|
|
4947
|
+
|
|
4948
|
+
/**
|
|
4949
|
+
* An event that fires when an extension fails to install in the security realm.
|
|
4950
|
+
*
|
|
4951
|
+
* @interface
|
|
4952
|
+
*/
|
|
4953
|
+
declare type ExtensionInstallFailedEvent = ExtensionEvent & {
|
|
4954
|
+
type: 'extension-install-failed';
|
|
4955
|
+
};
|
|
4956
|
+
|
|
4957
|
+
/**
|
|
4958
|
+
* An event that fires when extensions are disabled in the security realm.
|
|
4959
|
+
*
|
|
4960
|
+
* @interface
|
|
4961
|
+
*/
|
|
4962
|
+
declare type ExtensionsDisabledEvent = ExtensionsEvent & {
|
|
4963
|
+
type: 'extensions-disabled';
|
|
4964
|
+
};
|
|
4965
|
+
|
|
4966
|
+
/**
|
|
4967
|
+
* An event that fires when extensions are enabled in the security realm.
|
|
4968
|
+
*
|
|
4969
|
+
* @interface
|
|
4970
|
+
*/
|
|
4971
|
+
declare type ExtensionsEnabledEvent = ExtensionsEvent & {
|
|
4972
|
+
type: 'extensions-enabled';
|
|
4973
|
+
};
|
|
4974
|
+
|
|
4975
|
+
declare type ExtensionsEvent = SecurityRealmEvent & {
|
|
4976
|
+
/**
|
|
4977
|
+
* Runtime extensions whose status has been (possibly) modified
|
|
4978
|
+
*/
|
|
4979
|
+
extensions: string[];
|
|
4980
|
+
};
|
|
4981
|
+
|
|
4982
|
+
/**
|
|
4983
|
+
* An event that fires when requested extensions are not allowed to be installed in the security realm.
|
|
4984
|
+
*
|
|
4985
|
+
* @interface
|
|
4986
|
+
*/
|
|
4987
|
+
declare type ExtensionsExcludedEvent = ExtensionsEvent & {
|
|
4988
|
+
type: 'extensions-excluded';
|
|
4989
|
+
};
|
|
4990
|
+
|
|
4991
|
+
/**
|
|
4992
|
+
* An event that fires when extension initialization fails on initial app launch. Users may attempt to
|
|
4993
|
+
* re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
|
|
4994
|
+
* to manual extension refreshes (users should catch the error normally).
|
|
4995
|
+
*/
|
|
4996
|
+
declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
|
|
4997
|
+
type: 'extensions-initialization-failed';
|
|
4998
|
+
/**
|
|
4999
|
+
* The error that caused the extension initialization failure
|
|
5000
|
+
*/
|
|
5001
|
+
error: Error;
|
|
5002
|
+
};
|
|
5003
|
+
|
|
5004
|
+
/**
|
|
5005
|
+
* An event that fires when extensions are installed in the security realm.
|
|
5006
|
+
*
|
|
5007
|
+
* @interface
|
|
5008
|
+
*/
|
|
5009
|
+
declare type ExtensionsInstalledEvent = ExtensionsEvent & {
|
|
5010
|
+
type: 'extensions-installed';
|
|
5011
|
+
};
|
|
5012
|
+
|
|
5013
|
+
/**
|
|
5014
|
+
* An event that fires when extensions fail to install in the security realm.
|
|
5015
|
+
*
|
|
5016
|
+
* @interface
|
|
5017
|
+
*/
|
|
5018
|
+
declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
|
|
5019
|
+
type: 'extensions-install-failed';
|
|
5020
|
+
};
|
|
5021
|
+
|
|
4898
5022
|
/**
|
|
4899
5023
|
* An ExternalApplication object representing native language adapter connections to the runtime. Allows
|
|
4900
5024
|
* the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
|
|
@@ -4966,7 +5090,7 @@ declare type ExternalApplicationEventType = EventType_4;
|
|
|
4966
5090
|
* @interface
|
|
4967
5091
|
*/
|
|
4968
5092
|
declare type ExternalApplicationInfo = {
|
|
4969
|
-
parent:
|
|
5093
|
+
parent: Identity_4;
|
|
4970
5094
|
};
|
|
4971
5095
|
|
|
4972
5096
|
/**
|
|
@@ -5509,6 +5633,10 @@ declare type FileDownloadEvent = {
|
|
|
5509
5633
|
* The number of bytes of the item that have already been downloaded.
|
|
5510
5634
|
*/
|
|
5511
5635
|
downloadedBytes: number;
|
|
5636
|
+
/**
|
|
5637
|
+
* Unique identifier for the downloaded file.
|
|
5638
|
+
*/
|
|
5639
|
+
fileUuid: string;
|
|
5512
5640
|
} & NamedEvent;
|
|
5513
5641
|
|
|
5514
5642
|
/**
|
|
@@ -5760,7 +5888,7 @@ declare type FrameInfo = {
|
|
|
5760
5888
|
uuid: string;
|
|
5761
5889
|
url: string;
|
|
5762
5890
|
entityType: EntityType_4;
|
|
5763
|
-
parent:
|
|
5891
|
+
parent: Identity_4;
|
|
5764
5892
|
};
|
|
5765
5893
|
|
|
5766
5894
|
/**
|
|
@@ -5835,12 +5963,10 @@ declare type FrameProcessDetails = ProcessDetails & {
|
|
|
5835
5963
|
entityType: string;
|
|
5836
5964
|
};
|
|
5837
5965
|
|
|
5838
|
-
declare type GetLogRequestType = OpenFin.GetLogRequestType;
|
|
5839
|
-
|
|
5840
5966
|
/**
|
|
5841
5967
|
* @interface
|
|
5842
5968
|
*/
|
|
5843
|
-
declare type
|
|
5969
|
+
declare type GetLogRequestType = {
|
|
5844
5970
|
/**
|
|
5845
5971
|
* The name of the running application
|
|
5846
5972
|
*/
|
|
@@ -5860,7 +5986,7 @@ declare type GetWindowContextPayload = {
|
|
|
5860
5986
|
/**
|
|
5861
5987
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
5862
5988
|
*/
|
|
5863
|
-
target:
|
|
5989
|
+
target: Identity_4;
|
|
5864
5990
|
};
|
|
5865
5991
|
|
|
5866
5992
|
/**
|
|
@@ -6126,8 +6252,6 @@ declare type Identity_2 = OpenFin.Identity;
|
|
|
6126
6252
|
|
|
6127
6253
|
declare type Identity_3 = OpenFin.Identity;
|
|
6128
6254
|
|
|
6129
|
-
declare type Identity_4 = OpenFin.Identity;
|
|
6130
|
-
|
|
6131
6255
|
/**
|
|
6132
6256
|
* Unique identifier for a window, view or iframe.
|
|
6133
6257
|
*
|
|
@@ -6136,7 +6260,7 @@ declare type Identity_4 = OpenFin.Identity;
|
|
|
6136
6260
|
*
|
|
6137
6261
|
* @interface
|
|
6138
6262
|
*/
|
|
6139
|
-
declare type
|
|
6263
|
+
declare type Identity_4 = {
|
|
6140
6264
|
/**
|
|
6141
6265
|
* Universally unique identifier of the application that owns the component.
|
|
6142
6266
|
*/
|
|
@@ -6295,12 +6419,10 @@ declare type InstallationInfo = {
|
|
|
6295
6419
|
cachedManifest: any;
|
|
6296
6420
|
};
|
|
6297
6421
|
|
|
6298
|
-
declare type InstalledApps = OpenFin.InstalledApps;
|
|
6299
|
-
|
|
6300
6422
|
/**
|
|
6301
6423
|
* @interface
|
|
6302
6424
|
*/
|
|
6303
|
-
declare type
|
|
6425
|
+
declare type InstalledApps = {
|
|
6304
6426
|
[key: string]: InstallationInfo;
|
|
6305
6427
|
};
|
|
6306
6428
|
|
|
@@ -7071,7 +7193,7 @@ declare class InteropBroker extends Base {
|
|
|
7071
7193
|
* @param _id the identity tryinc to connect
|
|
7072
7194
|
* @param _connectionPayload optional payload to use in custom implementations, will be undefined by default
|
|
7073
7195
|
*/
|
|
7074
|
-
isConnectionAuthorized(_id:
|
|
7196
|
+
isConnectionAuthorized(_id: Identity_2, _connectionPayload?: any): Promise<boolean> | boolean;
|
|
7075
7197
|
/**
|
|
7076
7198
|
* Called before every action to check if this entity should be allowed to take the action.
|
|
7077
7199
|
* Return false to prevent the action
|
|
@@ -7989,7 +8111,7 @@ declare class Layout extends Base {
|
|
|
7989
8111
|
* await layout.replaceView(viewToReplace.identity, newViewConfig);
|
|
7990
8112
|
* ```
|
|
7991
8113
|
*/
|
|
7992
|
-
replaceView: (viewToReplace:
|
|
8114
|
+
replaceView: (viewToReplace: Identity_3, newView: OpenFin.PlatformViewCreationOptions) => Promise<void>;
|
|
7993
8115
|
/**
|
|
7994
8116
|
* Replaces a Platform window's layout with a preset layout arrangement using the existing Views attached to the window.
|
|
7995
8117
|
* The preset options are `columns`, `grid`, `rows`, and `tabs`.
|
|
@@ -8044,7 +8166,7 @@ declare type LayoutContent = Array<LayoutItemConfig | LayoutRow | LayoutColumn |
|
|
|
8044
8166
|
/**
|
|
8045
8167
|
* The base payload for the CustomEvent.detail property for Layout events emitted on the layout container element.
|
|
8046
8168
|
*/
|
|
8047
|
-
declare type LayoutDOMEvent =
|
|
8169
|
+
declare type LayoutDOMEvent = Identity_4 & {
|
|
8048
8170
|
type: string;
|
|
8049
8171
|
topic: 'openfin-DOM-event';
|
|
8050
8172
|
tabSelector: string;
|
|
@@ -8105,7 +8227,7 @@ declare type LayoutEntityTypes = 'column' | 'row' | 'stack';
|
|
|
8105
8227
|
/**
|
|
8106
8228
|
* @interface
|
|
8107
8229
|
*/
|
|
8108
|
-
declare type LayoutIdentity =
|
|
8230
|
+
declare type LayoutIdentity = Identity_4 & {
|
|
8109
8231
|
/**
|
|
8110
8232
|
* The name of the layout in a given window.
|
|
8111
8233
|
*/
|
|
@@ -8120,10 +8242,7 @@ declare type LayoutIdentity = Identity_5 & {
|
|
|
8120
8242
|
declare type LayoutInitializedEvent = BaseEvent_5 & {
|
|
8121
8243
|
type: 'layout-initialized';
|
|
8122
8244
|
layoutIdentity: OpenFin.LayoutIdentity;
|
|
8123
|
-
ofViews:
|
|
8124
|
-
identity: OpenFin.Identity;
|
|
8125
|
-
entityType: 'view';
|
|
8126
|
-
}[];
|
|
8245
|
+
ofViews: OpenFin.ViewCreationResult[];
|
|
8127
8246
|
};
|
|
8128
8247
|
|
|
8129
8248
|
/**
|
|
@@ -8214,7 +8333,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8214
8333
|
* @param identity
|
|
8215
8334
|
* @returns LayoutIdentity | undefined
|
|
8216
8335
|
*/
|
|
8217
|
-
resolveLayoutIdentity(identity?:
|
|
8336
|
+
resolveLayoutIdentity(identity?: Identity_4 | LayoutIdentity): LayoutIdentity | undefined;
|
|
8218
8337
|
/**
|
|
8219
8338
|
* @experimental
|
|
8220
8339
|
*
|
|
@@ -8231,7 +8350,7 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
|
8231
8350
|
/**
|
|
8232
8351
|
* @experimental
|
|
8233
8352
|
*/
|
|
8234
|
-
getLayoutIdentityForView(viewIdentity:
|
|
8353
|
+
getLayoutIdentityForView(viewIdentity: Identity_4): LayoutIdentity;
|
|
8235
8354
|
/**
|
|
8236
8355
|
* @experimental
|
|
8237
8356
|
*/
|
|
@@ -8535,12 +8654,10 @@ declare type Listener<T extends {
|
|
|
8535
8654
|
type: string;
|
|
8536
8655
|
}> = (payload: T) => void;
|
|
8537
8656
|
|
|
8538
|
-
declare type LogInfo = OpenFin.LogInfo;
|
|
8539
|
-
|
|
8540
8657
|
/**
|
|
8541
8658
|
* @interface
|
|
8542
8659
|
*/
|
|
8543
|
-
declare type
|
|
8660
|
+
declare type LogInfo = {
|
|
8544
8661
|
/**
|
|
8545
8662
|
* The filename of the log
|
|
8546
8663
|
*/
|
|
@@ -8555,8 +8672,6 @@ declare type LogInfo_2 = {
|
|
|
8555
8672
|
date: string;
|
|
8556
8673
|
};
|
|
8557
8674
|
|
|
8558
|
-
declare type LogLevel = OpenFin.LogLevel;
|
|
8559
|
-
|
|
8560
8675
|
/**
|
|
8561
8676
|
* Describes the minimum level (inclusive) above which logs will be written.
|
|
8562
8677
|
*
|
|
@@ -8566,7 +8681,7 @@ declare type LogLevel = OpenFin.LogLevel;
|
|
|
8566
8681
|
* `error` and above<br>
|
|
8567
8682
|
* `fatal`: fatal only, indicates a crash is imminent
|
|
8568
8683
|
*/
|
|
8569
|
-
declare type
|
|
8684
|
+
declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
8570
8685
|
|
|
8571
8686
|
/**
|
|
8572
8687
|
* @interface
|
|
@@ -8957,6 +9072,10 @@ declare type MutableViewOptions = {
|
|
|
8957
9072
|
* @defaultValue 'enabled'
|
|
8958
9073
|
*/
|
|
8959
9074
|
throttling: ViewThrottling;
|
|
9075
|
+
/**
|
|
9076
|
+
* {@inheritDoc ChromiumPolicies}
|
|
9077
|
+
*/
|
|
9078
|
+
chromiumPolicies: ChromiumPolicies;
|
|
8960
9079
|
};
|
|
8961
9080
|
|
|
8962
9081
|
/**
|
|
@@ -9197,6 +9316,12 @@ declare type MutableWindowOptions = {
|
|
|
9197
9316
|
* Shows the window's icon in the taskbar.
|
|
9198
9317
|
*/
|
|
9199
9318
|
showTaskbarIcon: boolean;
|
|
9319
|
+
/**
|
|
9320
|
+
* Specify a taskbar group for the window.
|
|
9321
|
+
* _If omitted, defaults to app's uuid (`fin.Application.getCurrentSync().identity.uuid`)._
|
|
9322
|
+
* @remarks It's only updatable when `enableJumpList` is set to false.
|
|
9323
|
+
*/
|
|
9324
|
+
taskbarIconGroup: string;
|
|
9200
9325
|
interop: InteropConfig;
|
|
9201
9326
|
/* Excluded from this release type: _internalWorkspaceData */
|
|
9202
9327
|
/* Excluded from this release type: workspacePlatform */
|
|
@@ -9208,6 +9333,10 @@ declare type MutableWindowOptions = {
|
|
|
9208
9333
|
* @remarks If `throttling` option is present, the `backgroundThrottling` option is completely ignored for windows.
|
|
9209
9334
|
*/
|
|
9210
9335
|
throttling: WindowThrottling;
|
|
9336
|
+
/**
|
|
9337
|
+
* {@inheritDoc ChromiumPolicies}
|
|
9338
|
+
*/
|
|
9339
|
+
chromiumPolicies: ChromiumPolicies;
|
|
9211
9340
|
};
|
|
9212
9341
|
|
|
9213
9342
|
declare type NackHandler = (payloadOrMessage: RuntimeErrorPayload | string) => void;
|
|
@@ -9376,13 +9505,13 @@ declare namespace OpenFin {
|
|
|
9376
9505
|
LayoutPosition,
|
|
9377
9506
|
WebContent,
|
|
9378
9507
|
PlatformProvider,
|
|
9379
|
-
|
|
9380
|
-
|
|
9508
|
+
ApplicationIdentity,
|
|
9509
|
+
Identity_4 as Identity,
|
|
9381
9510
|
ClientIdentity,
|
|
9382
9511
|
ClientInfo,
|
|
9383
9512
|
ClientIdentityMultiRuntime,
|
|
9384
9513
|
ClientConnectionPayload,
|
|
9385
|
-
|
|
9514
|
+
EntityInfo,
|
|
9386
9515
|
EntityType_4 as EntityType,
|
|
9387
9516
|
Bounds,
|
|
9388
9517
|
WindowBounds,
|
|
@@ -9418,8 +9547,11 @@ declare namespace OpenFin {
|
|
|
9418
9547
|
ViewVisibilityOptions,
|
|
9419
9548
|
WindowState,
|
|
9420
9549
|
AutoplayPolicyOptions,
|
|
9550
|
+
ExcludeOptions,
|
|
9421
9551
|
ConstWindowOptions,
|
|
9422
9552
|
InheritableOptions,
|
|
9553
|
+
PolicyOptions,
|
|
9554
|
+
ChromiumPolicies,
|
|
9423
9555
|
MutableWindowOptions,
|
|
9424
9556
|
WorkspacePlatformOptions,
|
|
9425
9557
|
WebRequestHeader,
|
|
@@ -9453,6 +9585,9 @@ declare namespace OpenFin {
|
|
|
9453
9585
|
ViewOptions,
|
|
9454
9586
|
ConstViewOptions,
|
|
9455
9587
|
ViewState,
|
|
9588
|
+
ViewCreationSuccess,
|
|
9589
|
+
ViewCreationFailure,
|
|
9590
|
+
ViewCreationResult,
|
|
9456
9591
|
Certificate,
|
|
9457
9592
|
HostContextChangedPayload,
|
|
9458
9593
|
ApplySnapshotOptions,
|
|
@@ -9516,7 +9651,7 @@ declare namespace OpenFin {
|
|
|
9516
9651
|
GpuInfo,
|
|
9517
9652
|
OSInfo,
|
|
9518
9653
|
HostSpecs,
|
|
9519
|
-
|
|
9654
|
+
PrinterInfo,
|
|
9520
9655
|
Dpi,
|
|
9521
9656
|
Margins,
|
|
9522
9657
|
PrintOptions,
|
|
@@ -9624,24 +9759,24 @@ declare namespace OpenFin {
|
|
|
9624
9759
|
BeforeUnloadUserDecision,
|
|
9625
9760
|
ViewStatuses,
|
|
9626
9761
|
CloseWindowPayload,
|
|
9627
|
-
|
|
9628
|
-
|
|
9762
|
+
ProxyInfo,
|
|
9763
|
+
ProxyConfig,
|
|
9629
9764
|
ProxySystemInfo,
|
|
9630
9765
|
ChannelAction_2 as ChannelAction,
|
|
9631
9766
|
ChannelMiddleware_2 as ChannelMiddleware,
|
|
9632
9767
|
ErrorMiddleware_2 as ErrorMiddleware,
|
|
9633
|
-
|
|
9634
|
-
|
|
9768
|
+
ApplicationState,
|
|
9769
|
+
InstalledApps,
|
|
9635
9770
|
InstallationInfo,
|
|
9636
|
-
|
|
9637
|
-
|
|
9771
|
+
GetLogRequestType,
|
|
9772
|
+
LogInfo,
|
|
9638
9773
|
SendApplicationLogResponse,
|
|
9639
|
-
|
|
9774
|
+
LogLevel,
|
|
9640
9775
|
PermissionState_2 as PermissionState,
|
|
9641
|
-
|
|
9776
|
+
RegistryInfo,
|
|
9642
9777
|
ApplicationType,
|
|
9643
9778
|
WindowInfo,
|
|
9644
|
-
|
|
9779
|
+
ApplicationWindowInfo,
|
|
9645
9780
|
WindowDetail,
|
|
9646
9781
|
LayoutPresetType,
|
|
9647
9782
|
LayoutIdentity,
|
|
@@ -9696,6 +9831,7 @@ declare namespace OpenFin {
|
|
|
9696
9831
|
RoutingInfo,
|
|
9697
9832
|
DownloadShelfOptions,
|
|
9698
9833
|
ViewShowAtOptions,
|
|
9834
|
+
ExtensionInfo,
|
|
9699
9835
|
ApplicationEvents,
|
|
9700
9836
|
BaseEvents,
|
|
9701
9837
|
ExternalApplicationEvents,
|
|
@@ -9897,6 +10033,10 @@ declare type PerDomainSettings = {
|
|
|
9897
10033
|
* {@link ContentRedirect} in {@link WindowOptions} and {@link ViewOptions} will be **ignored**.
|
|
9898
10034
|
*/
|
|
9899
10035
|
content?: ContentPermission;
|
|
10036
|
+
/**
|
|
10037
|
+
* {@inheritdoc ChromiumPolicies}
|
|
10038
|
+
*/
|
|
10039
|
+
chromiumPolicies?: ChromiumPolicies;
|
|
9900
10040
|
};
|
|
9901
10041
|
|
|
9902
10042
|
/**
|
|
@@ -11251,6 +11391,45 @@ declare interface PlatformProvider {
|
|
|
11251
11391
|
* @returns {Promise<void>}
|
|
11252
11392
|
*/
|
|
11253
11393
|
handleRunRequested({ manifest, userAppConfigArgs }: RunRequestedEvent): Promise<void>;
|
|
11394
|
+
/**
|
|
11395
|
+
* @experimental
|
|
11396
|
+
*
|
|
11397
|
+
* This method is called to handle errors with view creation and initial navigation during layout creation.
|
|
11398
|
+
* Overriding this method enables catching the error and correcting behavior (ie navigating to an error page).
|
|
11399
|
+
* * To indicate that the error has been handled, view creation should be treated as successful return {identity: viewIdentity, success: true}.
|
|
11400
|
+
* * Not returning anything will cause the layout-initialized event to include the view as failed with the original error.
|
|
11401
|
+
* * Throwing an error will update the error on the event payload of layout-initialized to the thrown error.
|
|
11402
|
+
*
|
|
11403
|
+
* @param viewIdentity Identity of the view
|
|
11404
|
+
* @param error error thrown during a view creation
|
|
11405
|
+
* @returns {Promise<OpenFin.ViewCreationSuccess | void>}
|
|
11406
|
+
*
|
|
11407
|
+
* @example
|
|
11408
|
+
*
|
|
11409
|
+
* ```js
|
|
11410
|
+
* const overrideCallback = (PlatformProvider) => {
|
|
11411
|
+
* class Override extends PlatformProvider {
|
|
11412
|
+
* async handleFailedViewCreation(viewIdentity, error) {
|
|
11413
|
+
* const view = fin.View.wrapSync(viewId);
|
|
11414
|
+
* try {
|
|
11415
|
+
* // navigate to an error page
|
|
11416
|
+
* await view.navigate('http://localhost:3000/errorPage.html');
|
|
11417
|
+
* // resolve a success result after redirecting to a error page
|
|
11418
|
+
* return {identity: viewIdentity, success: true};
|
|
11419
|
+
* } catch(e) {
|
|
11420
|
+
* // layout-initialized event will include this view with the error
|
|
11421
|
+
* throw error;
|
|
11422
|
+
* }
|
|
11423
|
+
* }
|
|
11424
|
+
* }
|
|
11425
|
+
* return new Override();
|
|
11426
|
+
* }
|
|
11427
|
+
*
|
|
11428
|
+
* fin.Platform.init({ overrideCallback });
|
|
11429
|
+
*
|
|
11430
|
+
* ```
|
|
11431
|
+
*/
|
|
11432
|
+
handleFailedViewCreation(viewIdentity: OpenFin.Identity, error: Error): Promise<OpenFin.ViewCreationSuccess | void>;
|
|
11254
11433
|
}
|
|
11255
11434
|
|
|
11256
11435
|
/**
|
|
@@ -11315,6 +11494,12 @@ declare type PointTopLeft = {
|
|
|
11315
11494
|
left: number;
|
|
11316
11495
|
};
|
|
11317
11496
|
|
|
11497
|
+
/**
|
|
11498
|
+
* When set to `disable`, disables the policy
|
|
11499
|
+
* When set to `defer-to-group-policy`, respects Group Policy settings
|
|
11500
|
+
*/
|
|
11501
|
+
declare type PolicyOptions = 'disable' | 'defer-to-group-policy';
|
|
11502
|
+
|
|
11318
11503
|
declare type PopupBaseBehavior = 'close' | 'hide';
|
|
11319
11504
|
|
|
11320
11505
|
declare type PopupBlurBehavior = 'modal' | PopupBaseBehavior;
|
|
@@ -11550,12 +11735,10 @@ declare type PresetLayoutOptions_2 = {
|
|
|
11550
11735
|
presetType: LayoutPresetType;
|
|
11551
11736
|
};
|
|
11552
11737
|
|
|
11553
|
-
declare type PrinterInfo = OpenFin.PrinterInfo;
|
|
11554
|
-
|
|
11555
11738
|
/**
|
|
11556
11739
|
* @interface
|
|
11557
11740
|
*/
|
|
11558
|
-
declare type
|
|
11741
|
+
declare type PrinterInfo = {
|
|
11559
11742
|
/**
|
|
11560
11743
|
* Printer Name
|
|
11561
11744
|
*/
|
|
@@ -11817,20 +12000,100 @@ declare type PropagatedWindowEvent<TargetTopic extends string> = PropagatedEvent
|
|
|
11817
12000
|
declare type PropagatedWindowEventType = PropagatedEvent_3<string>['type'];
|
|
11818
12001
|
|
|
11819
12002
|
declare interface ProtocolMap extends ProtocolMapBase {
|
|
12003
|
+
'is-application-running': ApplicationIdentityCall<{}, boolean>;
|
|
12004
|
+
'destroy-application': ApplicationIdentityCall<{
|
|
12005
|
+
force: boolean;
|
|
12006
|
+
}, void>;
|
|
12007
|
+
'close-application': ApplicationIdentityCall<{
|
|
12008
|
+
force: boolean;
|
|
12009
|
+
}, void>;
|
|
12010
|
+
'application-close': ApplicationIdentityCall<{}, void>;
|
|
12011
|
+
'get-child-windows': ApplicationIdentityCall<{}, Array<unknown>>;
|
|
12012
|
+
'get-application-manifest': {
|
|
12013
|
+
request: {
|
|
12014
|
+
manifestUrl?: string;
|
|
12015
|
+
uuid?: string;
|
|
12016
|
+
};
|
|
12017
|
+
response: OpenFin.Manifest;
|
|
12018
|
+
};
|
|
12019
|
+
'get-parent-application': ApplicationIdentityCall<{}, string>;
|
|
12020
|
+
'get-shortcuts': ApplicationIdentityCall<{}, OpenFin.ShortCutConfig>;
|
|
12021
|
+
'application-get-views': ApplicationIdentityCall<{}, OpenFin.Identity[]>;
|
|
12022
|
+
'get-application-zoom-level': ApplicationIdentityCall<{}, number>;
|
|
12023
|
+
'application-get-window': ApplicationIdentityCall<{}, void>;
|
|
12024
|
+
'register-user': ApplicationIdentityCall<{
|
|
12025
|
+
userName: string;
|
|
12026
|
+
appName: string;
|
|
12027
|
+
}, void>;
|
|
12028
|
+
'remove-tray-icon': ApplicationIdentityCall<{}, void>;
|
|
12029
|
+
'restart-application': ApplicationIdentityCall<{}, void>;
|
|
12030
|
+
'application-run': ApplicationIdentityCall<{}, void>;
|
|
12031
|
+
'run-application': ApplicationIdentityCall<{
|
|
12032
|
+
manifestUrl?: string | undefined;
|
|
12033
|
+
opts?: OpenFin.RvmLaunchOptions;
|
|
12034
|
+
}, void>;
|
|
12035
|
+
'relaunch-on-close': ApplicationIdentityCall<{}, void>;
|
|
12036
|
+
'send-application-log': ApplicationIdentityCall<{}, OpenFin.SendApplicationLogResponse>;
|
|
12037
|
+
'set-jump-list': ApplicationIdentityCall<{
|
|
12038
|
+
config: OpenFin.JumpListCategory[] | null;
|
|
12039
|
+
}, void>;
|
|
12040
|
+
'set-tray-icon': ApplicationIdentityCall<{
|
|
12041
|
+
enabledIcon: string;
|
|
12042
|
+
}, void>;
|
|
12043
|
+
'set-shortcuts': ApplicationIdentityCall<{
|
|
12044
|
+
data: OpenFin.ShortCutConfig;
|
|
12045
|
+
}, void>;
|
|
12046
|
+
'set-shortcut-query-args': ApplicationIdentityCall<{
|
|
12047
|
+
data: string;
|
|
12048
|
+
}, void>;
|
|
12049
|
+
'set-application-zoom-level': ApplicationIdentityCall<{
|
|
12050
|
+
level: number;
|
|
12051
|
+
}, void>;
|
|
12052
|
+
'set-app-log-username': ApplicationIdentityCall<{
|
|
12053
|
+
data: string;
|
|
12054
|
+
}, void>;
|
|
12055
|
+
'get-tray-icon-info': ApplicationIdentityCall<{}, OpenFin.TrayInfo>;
|
|
12056
|
+
'has-tray-icon': ApplicationIdentityCall<{}, boolean>;
|
|
12057
|
+
'terminate-application': ApplicationIdentityCall<{}, void>;
|
|
12058
|
+
'wait-for-hung-application': ApplicationIdentityCall<{}, void>;
|
|
12059
|
+
'get-info': ApplicationIdentityCall<{}, OpenFin.ApplicationInfo>;
|
|
12060
|
+
'application-get-process-info': ApplicationIdentityCall<{}, OpenFin.AppProcessInfo>;
|
|
12061
|
+
'set-file-download-location': {
|
|
12062
|
+
request: OpenFin.Identity & {
|
|
12063
|
+
downloadLocation: string;
|
|
12064
|
+
};
|
|
12065
|
+
response: void;
|
|
12066
|
+
};
|
|
12067
|
+
'get-file-download-location': ApplicationIdentityCall<{}, string>;
|
|
12068
|
+
'show-tray-icon-popup-menu': {
|
|
12069
|
+
request: OpenFin.Identity & {
|
|
12070
|
+
options: OpenFin.ShowTrayIconPopupMenuOptions;
|
|
12071
|
+
};
|
|
12072
|
+
response: OpenFin.MenuResult;
|
|
12073
|
+
};
|
|
12074
|
+
'close-tray-icon-popup-menu': IdentityCall<{}, void>;
|
|
12075
|
+
'wrap-application': VoidCall;
|
|
12076
|
+
'wrap-application-sync': VoidCall;
|
|
12077
|
+
'create-application': ApiCall<OpenFin.ApplicationCreationOptions, void>;
|
|
12078
|
+
'application-create': VoidCall;
|
|
12079
|
+
'start-application': VoidCall;
|
|
12080
|
+
'run-applications': ApiCall<{
|
|
12081
|
+
applications: Array<OpenFin.ManifestInfo>;
|
|
12082
|
+
opts?: OpenFin.RvmLaunchOptions;
|
|
12083
|
+
}, void>;
|
|
12084
|
+
'get-current-application': VoidCall;
|
|
12085
|
+
'get-current-application-sync': VoidCall;
|
|
12086
|
+
'application-start-from-manifest': VoidCall;
|
|
12087
|
+
'application-create-from-manifest': VoidCall;
|
|
11820
12088
|
'request-external-authorization': {
|
|
11821
12089
|
request: any;
|
|
11822
12090
|
response: void;
|
|
11823
12091
|
specialResponse: AuthorizationPayload;
|
|
11824
12092
|
};
|
|
11825
|
-
'
|
|
11826
|
-
request:
|
|
11827
|
-
response: OpenFin.Identity[];
|
|
11828
|
-
};
|
|
11829
|
-
'set-jump-list': {
|
|
11830
|
-
request: {
|
|
11831
|
-
config: OpenFin.JumpListCategory[] | null;
|
|
11832
|
-
} & OpenFin.ApplicationIdentity;
|
|
12093
|
+
'request-authorization': {
|
|
12094
|
+
request: ExistingConnectConfig | RemoteConfig | ReceiverConfig;
|
|
11833
12095
|
response: void;
|
|
12096
|
+
specialResponse: Payload;
|
|
11834
12097
|
};
|
|
11835
12098
|
'clipboard-read-formats': {
|
|
11836
12099
|
request: {
|
|
@@ -11842,6 +12105,24 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11842
12105
|
request: OpenFin.ReadImageClipboardRequest;
|
|
11843
12106
|
response: string;
|
|
11844
12107
|
};
|
|
12108
|
+
'clipboard-read-text': {
|
|
12109
|
+
request: {
|
|
12110
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12111
|
+
};
|
|
12112
|
+
response: string;
|
|
12113
|
+
};
|
|
12114
|
+
'clipboard-read-html': {
|
|
12115
|
+
request: {
|
|
12116
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12117
|
+
};
|
|
12118
|
+
response: string;
|
|
12119
|
+
};
|
|
12120
|
+
'clipboard-read-rtf': {
|
|
12121
|
+
request: {
|
|
12122
|
+
type?: OpenFin.ClipboardSelectionType;
|
|
12123
|
+
};
|
|
12124
|
+
response: string;
|
|
12125
|
+
};
|
|
11845
12126
|
'clipboard-write-image': {
|
|
11846
12127
|
request: OpenFin.WriteImageClipboardRequest;
|
|
11847
12128
|
response: void;
|
|
@@ -11850,6 +12131,18 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11850
12131
|
request: OpenFin.WriteAnyRequestType;
|
|
11851
12132
|
response: void;
|
|
11852
12133
|
};
|
|
12134
|
+
'clipboard-write-text': {
|
|
12135
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12136
|
+
response: void;
|
|
12137
|
+
};
|
|
12138
|
+
'clipboard-write-html': {
|
|
12139
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12140
|
+
response: void;
|
|
12141
|
+
};
|
|
12142
|
+
'clipboard-write-rtf': {
|
|
12143
|
+
request: OpenFin.WriteClipboardRequest;
|
|
12144
|
+
response: void;
|
|
12145
|
+
};
|
|
11853
12146
|
'get-view-window': IdentityCall<{}, OpenFin.Identity>;
|
|
11854
12147
|
'create-view': IdentityCall<OpenFin.ViewCreationOptions & {
|
|
11855
12148
|
uuid: string;
|
|
@@ -11875,13 +12168,85 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11875
12168
|
options: OpenFin.UpdatableViewOptions;
|
|
11876
12169
|
}>;
|
|
11877
12170
|
'trigger-before-unload': IdentityCall<{}, boolean>;
|
|
12171
|
+
'view-wrap-sync': VoidCall;
|
|
12172
|
+
'view-wrap': VoidCall;
|
|
12173
|
+
'view-get-current': VoidCall;
|
|
12174
|
+
'view-get-current-sync': VoidCall;
|
|
12175
|
+
'animate-window': IdentityCall<{
|
|
12176
|
+
transitions: OpenFin.Transition;
|
|
12177
|
+
options: OpenFin.TransitionOptions;
|
|
12178
|
+
}>;
|
|
12179
|
+
'get-all-frames': IdentityCall<{}, OpenFin.FrameInfo[]>;
|
|
12180
|
+
'get-window-bounds': IdentityCall<{}, OpenFin.WindowBounds>;
|
|
12181
|
+
'center-window': IdentityCall;
|
|
12182
|
+
'blur-window': IdentityCall;
|
|
12183
|
+
'bring-window-to-front': IdentityCall;
|
|
12184
|
+
'hide-window': IdentityCall;
|
|
12185
|
+
'close-window': IdentityCall<{
|
|
12186
|
+
force: boolean;
|
|
12187
|
+
}>;
|
|
12188
|
+
'focused-webview-changed': IdentityCall;
|
|
12189
|
+
'get-window-native-id': IdentityCall<{}, string>;
|
|
11878
12190
|
'window-get-views': IdentityCall<{}, OpenFin.Identity[]>;
|
|
11879
|
-
'
|
|
12191
|
+
'disable-window-frame': IdentityCall;
|
|
12192
|
+
'enable-window-frame': IdentityCall;
|
|
12193
|
+
'flash-window': IdentityCall;
|
|
12194
|
+
'stop-flash-window': IdentityCall;
|
|
12195
|
+
'get-window-info': IdentityCall<{}, OpenFin.WindowInfo>;
|
|
12196
|
+
'get-window-options': IdentityCall<{}, OpenFin.WindowOptions>;
|
|
12197
|
+
'get-window-snapshot': IdentityCall<{
|
|
12198
|
+
area?: OpenFin.Rectangle;
|
|
12199
|
+
}, string>;
|
|
12200
|
+
'get-window-state': IdentityCall<{}, 'minimized' | 'maximized' | 'normal'>;
|
|
12201
|
+
'is-window-showing': IdentityCall<{}, boolean>;
|
|
12202
|
+
'maximize-window': IdentityCall;
|
|
12203
|
+
'minimize-window': IdentityCall;
|
|
12204
|
+
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12205
|
+
deltaLeft: number;
|
|
12206
|
+
deltaTop: number;
|
|
12207
|
+
}>>;
|
|
12208
|
+
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12209
|
+
left: number;
|
|
12210
|
+
top: number;
|
|
12211
|
+
}>>;
|
|
12212
|
+
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12213
|
+
deltaWidth: number;
|
|
12214
|
+
deltaHeight: number;
|
|
12215
|
+
anchor: OpenFin.AnchorType;
|
|
12216
|
+
}>>;
|
|
12217
|
+
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12218
|
+
width: number;
|
|
12219
|
+
height: number;
|
|
12220
|
+
anchor: OpenFin.AnchorType;
|
|
12221
|
+
}>>;
|
|
12222
|
+
'restore-window': IdentityCall;
|
|
12223
|
+
'set-foreground-window': IdentityCall;
|
|
12224
|
+
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12225
|
+
'show-window': IdentityCall<{
|
|
12226
|
+
force: boolean;
|
|
12227
|
+
}>;
|
|
12228
|
+
'show-at-window': IdentityCall<{
|
|
12229
|
+
left: number;
|
|
12230
|
+
top: number;
|
|
12231
|
+
force: boolean;
|
|
12232
|
+
}>;
|
|
12233
|
+
'update-window-options': IdentityCall<{
|
|
12234
|
+
options: OpenFin.UpdatableWindowOptions;
|
|
12235
|
+
}>;
|
|
12236
|
+
'window-authenticate': IdentityCall<{
|
|
12237
|
+
userName: string;
|
|
12238
|
+
password: string;
|
|
12239
|
+
}>;
|
|
12240
|
+
'show-popup-menu': {
|
|
11880
12241
|
request: OpenFin.Identity & {
|
|
11881
|
-
options: OpenFin.
|
|
12242
|
+
options: OpenFin.ShowPopupMenuOptions;
|
|
11882
12243
|
};
|
|
11883
|
-
response:
|
|
12244
|
+
response: OpenFin.MenuResult;
|
|
11884
12245
|
};
|
|
12246
|
+
'close-popup-menu': IdentityCall;
|
|
12247
|
+
'dispatch-popup-result': IdentityCall<{
|
|
12248
|
+
data: any;
|
|
12249
|
+
}>;
|
|
11885
12250
|
'print-screenshot': {
|
|
11886
12251
|
request: OpenFin.Identity;
|
|
11887
12252
|
response: void;
|
|
@@ -11892,6 +12257,229 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11892
12257
|
};
|
|
11893
12258
|
response: void;
|
|
11894
12259
|
};
|
|
12260
|
+
'window-wrap': VoidCall;
|
|
12261
|
+
'window-wrap-sync': VoidCall;
|
|
12262
|
+
'create-window': VoidCall;
|
|
12263
|
+
'get-current-window': VoidCall;
|
|
12264
|
+
'get-current-window-sync': VoidCall;
|
|
12265
|
+
'get-external-application-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.ExternalApplicationInfo>;
|
|
12266
|
+
'external-application-wrap': VoidCall;
|
|
12267
|
+
'external-application-wrap-sync': VoidCall;
|
|
12268
|
+
'get-frame-info': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12269
|
+
'get-parent-window': ApiCall<OpenFin.Identity, OpenFin.FrameInfo>;
|
|
12270
|
+
'frame-wrap': VoidCall;
|
|
12271
|
+
'frame-wrap-sync': VoidCall;
|
|
12272
|
+
'frame-get-current': VoidCall;
|
|
12273
|
+
'frame-get-current-sync': VoidCall;
|
|
12274
|
+
'global-hotkey-register': {
|
|
12275
|
+
request: {
|
|
12276
|
+
hotkey: string;
|
|
12277
|
+
};
|
|
12278
|
+
response: void;
|
|
12279
|
+
};
|
|
12280
|
+
'global-hotkey-unregister': {
|
|
12281
|
+
request: {
|
|
12282
|
+
hotkey: string;
|
|
12283
|
+
};
|
|
12284
|
+
response: void;
|
|
12285
|
+
};
|
|
12286
|
+
'global-hotkey-unregister-all': {
|
|
12287
|
+
request: {};
|
|
12288
|
+
response: void;
|
|
12289
|
+
};
|
|
12290
|
+
'global-hotkey-is-registered': {
|
|
12291
|
+
request: {
|
|
12292
|
+
hotkey: string;
|
|
12293
|
+
};
|
|
12294
|
+
response: boolean;
|
|
12295
|
+
};
|
|
12296
|
+
'publish-message': {
|
|
12297
|
+
request: {
|
|
12298
|
+
topic: string;
|
|
12299
|
+
message: any;
|
|
12300
|
+
sourceWindowName: string;
|
|
12301
|
+
};
|
|
12302
|
+
response: void;
|
|
12303
|
+
};
|
|
12304
|
+
'send-message': {
|
|
12305
|
+
request: {
|
|
12306
|
+
destinationUuid: string;
|
|
12307
|
+
destinationWindowName: string | undefined;
|
|
12308
|
+
topic: string;
|
|
12309
|
+
message: any;
|
|
12310
|
+
sourceWindowName: string;
|
|
12311
|
+
};
|
|
12312
|
+
response: void;
|
|
12313
|
+
};
|
|
12314
|
+
'subscribe': {
|
|
12315
|
+
request: {
|
|
12316
|
+
sourceUuid: string;
|
|
12317
|
+
sourceWindowName: string;
|
|
12318
|
+
topic: string;
|
|
12319
|
+
destinationWindowName: string;
|
|
12320
|
+
messageKey?: any;
|
|
12321
|
+
};
|
|
12322
|
+
response: void;
|
|
12323
|
+
};
|
|
12324
|
+
'unsubscribe': {
|
|
12325
|
+
request: {
|
|
12326
|
+
sourceUuid: string;
|
|
12327
|
+
sourceWindowName: string;
|
|
12328
|
+
topic: string;
|
|
12329
|
+
destinationWindowName: string;
|
|
12330
|
+
};
|
|
12331
|
+
response: void;
|
|
12332
|
+
};
|
|
12333
|
+
'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
|
|
12334
|
+
'connect-to-channel': {
|
|
12335
|
+
request: any;
|
|
12336
|
+
response: OpenFin.RoutingInfo;
|
|
12337
|
+
};
|
|
12338
|
+
'create-channel': ApiCall<{
|
|
12339
|
+
channelName: string;
|
|
12340
|
+
}, OpenFin.ProviderIdentity>;
|
|
12341
|
+
'destroy-channel': ApiCall<{
|
|
12342
|
+
channelName: string;
|
|
12343
|
+
}, void>;
|
|
12344
|
+
'disconnect-from-channel': {
|
|
12345
|
+
request: {
|
|
12346
|
+
channelName: string;
|
|
12347
|
+
uuid: string;
|
|
12348
|
+
name: string;
|
|
12349
|
+
endpointId: string;
|
|
12350
|
+
};
|
|
12351
|
+
response: void;
|
|
12352
|
+
};
|
|
12353
|
+
'send-channel-message': {
|
|
12354
|
+
request: any;
|
|
12355
|
+
response: any;
|
|
12356
|
+
};
|
|
12357
|
+
'get-version': GetterCall<string>;
|
|
12358
|
+
'clear-cache': ApiCall<OpenFin.ClearCacheOption, void>;
|
|
12359
|
+
'delete-cache-request': VoidCall;
|
|
12360
|
+
'exit-desktop': VoidCall;
|
|
12361
|
+
'fetch-manifest': ApiCall<{
|
|
12362
|
+
manifestUrl: string;
|
|
12363
|
+
}, any>;
|
|
12364
|
+
'flush-cookie-store': VoidCall;
|
|
12365
|
+
'get-all-windows': GetterCall<OpenFin.ApplicationWindowInfo[]>;
|
|
12366
|
+
'get-all-applications': GetterCall<OpenFin.ApplicationState[]>;
|
|
12367
|
+
'get-command-line-arguments': GetterCall<string>;
|
|
12368
|
+
'get-crash-reporter-state': GetterCall<OpenFin.CrashReporterState>;
|
|
12369
|
+
'start-crash-reporter': {
|
|
12370
|
+
request: OpenFin.CrashReporterOptions | {
|
|
12371
|
+
diagnosticMode: boolean;
|
|
12372
|
+
};
|
|
12373
|
+
response: OpenFin.CrashReporterState;
|
|
12374
|
+
};
|
|
12375
|
+
'get-unique-user-id': GetterCall<string>;
|
|
12376
|
+
'get-entity-info': {
|
|
12377
|
+
request: {
|
|
12378
|
+
uuid: string;
|
|
12379
|
+
name: string;
|
|
12380
|
+
};
|
|
12381
|
+
response: OpenFin.EntityInfo;
|
|
12382
|
+
};
|
|
12383
|
+
'get-environment-variable': {
|
|
12384
|
+
request: {
|
|
12385
|
+
environmentVariables: string;
|
|
12386
|
+
};
|
|
12387
|
+
response: string;
|
|
12388
|
+
};
|
|
12389
|
+
'get-focused-window': GetterCall<OpenFin.Identity | null>;
|
|
12390
|
+
'is-app-certified': {
|
|
12391
|
+
request: {
|
|
12392
|
+
manifestUrl: string;
|
|
12393
|
+
};
|
|
12394
|
+
response: {
|
|
12395
|
+
action: string;
|
|
12396
|
+
certifiedInfo: OpenFin.CertifiedAppInfo;
|
|
12397
|
+
};
|
|
12398
|
+
};
|
|
12399
|
+
'get-installed-runtimes': GetterCall<{
|
|
12400
|
+
action: string;
|
|
12401
|
+
runtimes: string[];
|
|
12402
|
+
}>;
|
|
12403
|
+
'get-installed-apps': GetterCall<OpenFin.InstalledApps>;
|
|
12404
|
+
'view-log': ApiCall<OpenFin.GetLogRequestType, string>;
|
|
12405
|
+
'get-machine-id': GetterCall<string>;
|
|
12406
|
+
'get-min-log-level': GetterCall<OpenFin.LogLevel>;
|
|
12407
|
+
'list-logs': GetterCall<OpenFin.LogInfo[]>;
|
|
12408
|
+
'get-monitor-info': GetterCall<OpenFin.MonitorInfo>;
|
|
12409
|
+
'get-mouse-position': GetterCall<OpenFin.PointTopLeft>;
|
|
12410
|
+
'process-snapshot': GetterCall<Array<any>>;
|
|
12411
|
+
'get-all-process-info': ApiCall<OpenFin.ApplicationIdentity, OpenFin.SystemProcessInfo>;
|
|
12412
|
+
'get-proxy-settings': GetterCall<OpenFin.ProxyInfo>;
|
|
12413
|
+
'get-runtime-info': GetterCall<OpenFin.RuntimeInfo>;
|
|
12414
|
+
'get-rvm-info': GetterCall<OpenFin.RVMInfo>;
|
|
12415
|
+
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12416
|
+
'get-os-info': GetterCall<OpenFin.OSInfo>;
|
|
12417
|
+
'launch-external-process': ApiCall<OpenFin.ExternalProcessRequestType, OpenFin.Identity>;
|
|
12418
|
+
'monitor-external-process': ApiCall<OpenFin.ExternalProcessInfo, OpenFin.Identity>;
|
|
12419
|
+
'write-to-log': ApiCall<{
|
|
12420
|
+
level: string;
|
|
12421
|
+
message: string;
|
|
12422
|
+
}, void>;
|
|
12423
|
+
'open-url-with-browser': ApiCall<{
|
|
12424
|
+
url: string;
|
|
12425
|
+
}, void>;
|
|
12426
|
+
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12427
|
+
'unregister-custom-protocol': ApiCall<{
|
|
12428
|
+
protocolName: string;
|
|
12429
|
+
}, void>;
|
|
12430
|
+
'get-custom-protocol-state': ApiCall<{
|
|
12431
|
+
protocolName: string;
|
|
12432
|
+
}, OpenFin.CustomProtocolState>;
|
|
12433
|
+
'release-external-process': ApiCall<{
|
|
12434
|
+
uuid: string;
|
|
12435
|
+
}, void>;
|
|
12436
|
+
'show-developer-tools': ApiCall<OpenFin.Identity, void>;
|
|
12437
|
+
'terminate-external-process': ApiCall<OpenFin.TerminateExternalRequestType, void>;
|
|
12438
|
+
'update-proxy': ApiCall<OpenFin.ProxyConfig, void>;
|
|
12439
|
+
'download-asset': {
|
|
12440
|
+
request: OpenFin.AppAssetInfo & {
|
|
12441
|
+
downloadId: string;
|
|
12442
|
+
};
|
|
12443
|
+
response: void;
|
|
12444
|
+
};
|
|
12445
|
+
'download-runtime': {
|
|
12446
|
+
request: OpenFin.RuntimeDownloadOptions & {
|
|
12447
|
+
downloadId: string;
|
|
12448
|
+
};
|
|
12449
|
+
response: void;
|
|
12450
|
+
};
|
|
12451
|
+
'download-preload-scripts': ApiCall<{
|
|
12452
|
+
scripts: Array<OpenFin.DownloadPreloadOption>;
|
|
12453
|
+
}, Array<OpenFin.DownloadPreloadInfo>>;
|
|
12454
|
+
'get-all-external-applications': ApiCall<void, Array<OpenFin.Identity>>;
|
|
12455
|
+
'get-app-asset-info': ApiCall<OpenFin.AppAssetRequest, OpenFin.AppAssetInfo>;
|
|
12456
|
+
'get-cookies': {
|
|
12457
|
+
request: OpenFin.CookieOption & {
|
|
12458
|
+
url: string;
|
|
12459
|
+
};
|
|
12460
|
+
response: Array<OpenFin.CookieInfo>;
|
|
12461
|
+
};
|
|
12462
|
+
'set-min-log-level': ApiCall<{
|
|
12463
|
+
level: OpenFin.LogLevel;
|
|
12464
|
+
}, void>;
|
|
12465
|
+
'resolve-uuid': ApiCall<{
|
|
12466
|
+
entityKey: string;
|
|
12467
|
+
}, OpenFin.ApplicationType>;
|
|
12468
|
+
'read-registry-value': ApiCall<{
|
|
12469
|
+
rootKey: string;
|
|
12470
|
+
subkey: string;
|
|
12471
|
+
value: string;
|
|
12472
|
+
}, OpenFin.RegistryInfo>;
|
|
12473
|
+
'register-external-connection': ApiCall<{
|
|
12474
|
+
uuid: string;
|
|
12475
|
+
}, OpenFin.ExternalConnection>;
|
|
12476
|
+
'get-service-configuration': ApiCall<{
|
|
12477
|
+
name: string;
|
|
12478
|
+
}, OpenFin.ServiceConfiguration>;
|
|
12479
|
+
'get-system-app-configuration': ApiCall<{
|
|
12480
|
+
name: string;
|
|
12481
|
+
}, any>;
|
|
12482
|
+
'run-rvm-health-check': ApiCall<void, string[]>;
|
|
11895
12483
|
'launch-manifest': {
|
|
11896
12484
|
request: {
|
|
11897
12485
|
manifestUrl: string;
|
|
@@ -11903,17 +12491,12 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11903
12491
|
manifest: OpenFin.Manifest;
|
|
11904
12492
|
};
|
|
11905
12493
|
};
|
|
11906
|
-
'
|
|
12494
|
+
'query-permission-for-current-context': {
|
|
11907
12495
|
request: {
|
|
11908
|
-
|
|
11909
|
-
|
|
11910
|
-
response: any;
|
|
11911
|
-
};
|
|
11912
|
-
'show-popup-menu': {
|
|
11913
|
-
request: OpenFin.Identity & {
|
|
11914
|
-
options: OpenFin.ShowPopupMenuOptions;
|
|
12496
|
+
apiName: string;
|
|
12497
|
+
identity: OpenFin.Identity;
|
|
11915
12498
|
};
|
|
11916
|
-
response: OpenFin.
|
|
12499
|
+
response: OpenFin.QueryPermissionResult;
|
|
11917
12500
|
};
|
|
11918
12501
|
'enable-native-window-integration-provider': {
|
|
11919
12502
|
request: {
|
|
@@ -11921,24 +12504,42 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11921
12504
|
};
|
|
11922
12505
|
response: OpenFin.NativeWindowIntegrationProviderAuthorization;
|
|
11923
12506
|
};
|
|
12507
|
+
'register-usage': ApiCall<OpenFin.RegisterUsageData, void>;
|
|
12508
|
+
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12509
|
+
'system-update-process-logging-options': ApiCall<{
|
|
12510
|
+
options: OpenFin.ProcessLoggingOptions;
|
|
12511
|
+
}, void>;
|
|
12512
|
+
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12513
|
+
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12514
|
+
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12515
|
+
}, void>;
|
|
12516
|
+
'system-register-shutdown-handler': VoidCall;
|
|
11924
12517
|
'get-permissions': GetterCall<any>;
|
|
11925
|
-
'
|
|
11926
|
-
|
|
11927
|
-
|
|
11928
|
-
downloadLocation: string;
|
|
11929
|
-
};
|
|
11930
|
-
response: void;
|
|
12518
|
+
'refresh-extensions': {
|
|
12519
|
+
request: void;
|
|
12520
|
+
response: string[] | undefined;
|
|
11931
12521
|
};
|
|
11932
|
-
'get-
|
|
11933
|
-
request:
|
|
11934
|
-
response:
|
|
12522
|
+
'get-installed-extensions': {
|
|
12523
|
+
request: void;
|
|
12524
|
+
response: OpenFin.ExtensionInfo[];
|
|
11935
12525
|
};
|
|
11936
|
-
'close-popup-menu': IdentityCall;
|
|
11937
12526
|
'fdc3-add-context-listener': VoidCall;
|
|
12527
|
+
'fdc3-add-intent-listener': VoidCall;
|
|
12528
|
+
'fdc3-raise-intent': VoidCall;
|
|
12529
|
+
'fdc3-find-intent': VoidCall;
|
|
12530
|
+
'fdc3-find-intents-by-context': VoidCall;
|
|
12531
|
+
'fdc3-raise-intent-for-context': VoidCall;
|
|
12532
|
+
'fdc3-get-info': VoidCall;
|
|
12533
|
+
'fdc3-find-instances': VoidCall;
|
|
12534
|
+
'fdc3-get-app-metadata': VoidCall;
|
|
11938
12535
|
'fdc3-broadcast': VoidCall;
|
|
12536
|
+
'fdc3-open': VoidCall;
|
|
12537
|
+
'fdc3-get-or-create-channel': VoidCall;
|
|
11939
12538
|
'fdc3-get-system-channels': VoidCall;
|
|
11940
12539
|
'fdc3-join-channel': VoidCall;
|
|
12540
|
+
'fdc3-get-current-channel': VoidCall;
|
|
11941
12541
|
'fdc3-leave-current-channel': VoidCall;
|
|
12542
|
+
'interop-init': VoidCall;
|
|
11942
12543
|
'interop-connect-sync': VoidCall;
|
|
11943
12544
|
'interop-client-set-context': VoidCall;
|
|
11944
12545
|
'interop-client-add-context-handler': VoidCall;
|
|
@@ -11947,6 +12548,13 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11947
12548
|
'interop-client-remove-from-context-group': VoidCall;
|
|
11948
12549
|
'interop-client-get-all-clients-in-context-group': VoidCall;
|
|
11949
12550
|
'interop-client-get-info-for-context-group': VoidCall;
|
|
12551
|
+
'interop-client-fire-intent': VoidCall;
|
|
12552
|
+
'interop-client-register-intent-handler': VoidCall;
|
|
12553
|
+
'interop-client-get-current-context': VoidCall;
|
|
12554
|
+
'interop-client-get-info-for-intent': VoidCall;
|
|
12555
|
+
'interop-client-get-info-for-intents-by-context': VoidCall;
|
|
12556
|
+
'interop-client-fire-intent-for-context': VoidCall;
|
|
12557
|
+
'interop-client-add-ondisconnection-listener': VoidCall;
|
|
11950
12558
|
'interop-broker-add-client-to-context-group': VoidCall;
|
|
11951
12559
|
'interop-broker-get-all-clients-in-context-group': VoidCall;
|
|
11952
12560
|
'interop-broker-get-context-groups': VoidCall;
|
|
@@ -11958,13 +12566,100 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11958
12566
|
'interop-broker-remove-from-context-group': VoidCall;
|
|
11959
12567
|
'interop-broker-set-context': VoidCall;
|
|
11960
12568
|
'interop-broker-set-context-for-group': VoidCall;
|
|
11961
|
-
'
|
|
11962
|
-
|
|
11963
|
-
|
|
11964
|
-
|
|
11965
|
-
|
|
11966
|
-
|
|
11967
|
-
|
|
12569
|
+
'interop-broker-get-current-context': VoidCall;
|
|
12570
|
+
'interop-broker-set-intent-target': VoidCall;
|
|
12571
|
+
'interop-session-context-group-set-context': VoidCall;
|
|
12572
|
+
'interop-session-context-group-get-context': VoidCall;
|
|
12573
|
+
'interop-session-context-group-add-handler': VoidCall;
|
|
12574
|
+
'platform-wrap': VoidCall;
|
|
12575
|
+
'platform-wrap-sync': VoidCall;
|
|
12576
|
+
'platform-get-current': VoidCall;
|
|
12577
|
+
'platform-get-current-sync': VoidCall;
|
|
12578
|
+
'platform-start': VoidCall;
|
|
12579
|
+
'platform-start-from-manifest': VoidCall;
|
|
12580
|
+
'platform-get-client': ApplicationIdentityCall<{}, void>;
|
|
12581
|
+
'platform-create-view': ApplicationIdentityCall<{}, void>;
|
|
12582
|
+
'platform-create-window': ApplicationIdentityCall<{}, void>;
|
|
12583
|
+
'platform-quit': ApplicationIdentityCall<{}, void>;
|
|
12584
|
+
'platform-close-view': ApplicationIdentityCall<{}, void>;
|
|
12585
|
+
'platform-reparent-view': ApplicationIdentityCall<{}, void>;
|
|
12586
|
+
'platform-get-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12587
|
+
'platform-apply-snapshot': ApplicationIdentityCall<{}, void>;
|
|
12588
|
+
'platform-launch-content-manifest': ApplicationIdentityCall<{}, void>;
|
|
12589
|
+
'platform-set-window-context': ApplicationIdentityCall<{}, void>;
|
|
12590
|
+
'platform-get-window-context': ApplicationIdentityCall<{}, void>;
|
|
12591
|
+
'platform-close-window': ApplicationIdentityCall<{}, void>;
|
|
12592
|
+
'layout-wrap': VoidCall;
|
|
12593
|
+
'layout-wrap-sync': VoidCall;
|
|
12594
|
+
'layout-get-current': VoidCall;
|
|
12595
|
+
'layout-get-current-sync': VoidCall;
|
|
12596
|
+
'layout-init': VoidCall;
|
|
12597
|
+
'layout-get-config': VoidCall;
|
|
12598
|
+
'layout-get-views': VoidCall;
|
|
12599
|
+
'layout-replace': VoidCall;
|
|
12600
|
+
'layout-get-root-item': VoidCall;
|
|
12601
|
+
'layout-replace-view': VoidCall;
|
|
12602
|
+
'layout-apply-preset': VoidCall;
|
|
12603
|
+
'layout-controller-get-root': VoidCall;
|
|
12604
|
+
'layout-controller-get-stack-by-view': VoidCall;
|
|
12605
|
+
'layout-controller-get-stack-views': VoidCall;
|
|
12606
|
+
'layout-controller-get-content': VoidCall;
|
|
12607
|
+
'layout-controller-get-parent': VoidCall;
|
|
12608
|
+
'layout-controller-is-root': VoidCall;
|
|
12609
|
+
'layout-controller-exists': VoidCall;
|
|
12610
|
+
'layout-controller-add-view-to-stack': VoidCall;
|
|
12611
|
+
'layout-controller-remove-view-from-stack': VoidCall;
|
|
12612
|
+
'layout-controller-create-adjacent-stack': VoidCall;
|
|
12613
|
+
'layout-controller-get-adjacent-stacks': VoidCall;
|
|
12614
|
+
'layout-controller-set-stack-active-view': VoidCall;
|
|
12615
|
+
'snapshot-source-init': VoidCall;
|
|
12616
|
+
'snapshot-source-wrap-sync': VoidCall;
|
|
12617
|
+
'snapshot-source-wrap': VoidCall;
|
|
12618
|
+
'snapshot-source-ready': VoidCall;
|
|
12619
|
+
'snapshot-source-get-snapshot': VoidCall;
|
|
12620
|
+
'snapshot-source-apply-snapshot': VoidCall;
|
|
12621
|
+
'capture-page': IdentityCall<{
|
|
12622
|
+
options?: OpenFin.CapturePageOptions;
|
|
12623
|
+
}, string>;
|
|
12624
|
+
'execute-javascript-in-window': IdentityCall<{
|
|
12625
|
+
code: string;
|
|
12626
|
+
}, unknown>;
|
|
12627
|
+
'get-zoom-level': IdentityCall<{}, number>;
|
|
12628
|
+
'set-zoom-level': IdentityCall<{
|
|
12629
|
+
level: number;
|
|
12630
|
+
}, void>;
|
|
12631
|
+
'navigate-window': IdentityCall<{
|
|
12632
|
+
url: string;
|
|
12633
|
+
}, void>;
|
|
12634
|
+
'navigate-window-back': IdentityCall<{}, void>;
|
|
12635
|
+
'navigate-window-forward': IdentityCall<{}, void>;
|
|
12636
|
+
'stop-window-navigation': IdentityCall<{}, void>;
|
|
12637
|
+
'reload-window': IdentityCall<{
|
|
12638
|
+
ignoreCache: boolean;
|
|
12639
|
+
}, void>;
|
|
12640
|
+
'print': IdentityCall<{
|
|
12641
|
+
options: OpenFin.PrintOptions;
|
|
12642
|
+
}, void>;
|
|
12643
|
+
'find-in-page': IdentityCall<{
|
|
12644
|
+
searchTerm: string;
|
|
12645
|
+
options?: OpenFin.FindInPageOptions;
|
|
12646
|
+
}, void>;
|
|
12647
|
+
'stop-find-in-page': IdentityCall<{
|
|
12648
|
+
action: 'clearSelection' | 'keepSelection' | 'activateSelection';
|
|
12649
|
+
}, void>;
|
|
12650
|
+
'get-printers': IdentityCall<{}, OpenFin.PrinterInfo>;
|
|
12651
|
+
'focus-window': IdentityCall<{
|
|
12652
|
+
emitSynthFocused: boolean;
|
|
12653
|
+
}, void>;
|
|
12654
|
+
'get-process-info': IdentityCall<{}, OpenFin.EntityProcessDetails>;
|
|
12655
|
+
'get-shared-workers': IdentityCall<{}, OpenFin.SharedWorkerInfo[]>;
|
|
12656
|
+
'inspect-shared-worker': IdentityCall<{}, void>;
|
|
12657
|
+
'inspect-shared-worker-by-id': IdentityCall<{
|
|
12658
|
+
workerId: string;
|
|
12659
|
+
}, void>;
|
|
12660
|
+
'inspect-service-worker': IdentityCall<{}, void>;
|
|
12661
|
+
'view-show-popup-window': IdentityCall<{}, void>;
|
|
12662
|
+
'window-show-popup-window': IdentityCall<{}, void>;
|
|
11968
12663
|
'try-create-popup-window': {
|
|
11969
12664
|
request: OpenFin.Identity & {
|
|
11970
12665
|
options: OpenFin.PopupOptions;
|
|
@@ -11980,9 +12675,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11980
12675
|
};
|
|
11981
12676
|
response: OpenFin.PopupResult;
|
|
11982
12677
|
};
|
|
11983
|
-
'dispatch-popup-result': IdentityCall<{
|
|
11984
|
-
data: any;
|
|
11985
|
-
}>;
|
|
11986
12678
|
'render-overlay': {
|
|
11987
12679
|
request: {
|
|
11988
12680
|
bounds: OpenFin.Bounds;
|
|
@@ -12002,40 +12694,6 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
12002
12694
|
};
|
|
12003
12695
|
response: void;
|
|
12004
12696
|
};
|
|
12005
|
-
'get-host-specs': GetterCall<OpenFin.HostSpecs>;
|
|
12006
|
-
'get-os-info': GetterCall<OpenFin.OSInfo>;
|
|
12007
|
-
'system-get-printers': GetterCall<OpenFin.PrinterInfo[]>;
|
|
12008
|
-
'system-register-shutdown-handler': VoidCall;
|
|
12009
|
-
'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
|
|
12010
|
-
'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
|
|
12011
|
-
domainSettings: OpenFin.DefaultDomainSettings;
|
|
12012
|
-
}, void>;
|
|
12013
|
-
'move-window-by': IdentityCall<WithPositioningOptions<{
|
|
12014
|
-
deltaLeft: number;
|
|
12015
|
-
deltaTop: number;
|
|
12016
|
-
}>>;
|
|
12017
|
-
'move-window': IdentityCall<WithPositioningOptions<{
|
|
12018
|
-
left: number;
|
|
12019
|
-
top: number;
|
|
12020
|
-
}>>;
|
|
12021
|
-
'resize-window-by': IdentityCall<WithPositioningOptions<{
|
|
12022
|
-
deltaWidth: number;
|
|
12023
|
-
deltaHeight: number;
|
|
12024
|
-
anchor: OpenFin.AnchorType;
|
|
12025
|
-
}>>;
|
|
12026
|
-
'resize-window': IdentityCall<WithPositioningOptions<{
|
|
12027
|
-
width: number;
|
|
12028
|
-
height: number;
|
|
12029
|
-
anchor: OpenFin.AnchorType;
|
|
12030
|
-
}>>;
|
|
12031
|
-
'set-window-bounds': IdentityCall<WithPositioningOptions<Partial<OpenFin.Bounds>>>;
|
|
12032
|
-
'register-custom-protocol': ApiCall<OpenFin.CustomProtocolOptions, void>;
|
|
12033
|
-
'unregister-custom-protocol': ApiCall<{
|
|
12034
|
-
protocolName: string;
|
|
12035
|
-
}, void>;
|
|
12036
|
-
'get-custom-protocol-state': ApiCall<{
|
|
12037
|
-
protocolName: string;
|
|
12038
|
-
}, OpenFin.CustomProtocolState>;
|
|
12039
12697
|
}
|
|
12040
12698
|
|
|
12041
12699
|
declare interface ProtocolMapBase {
|
|
@@ -12065,7 +12723,7 @@ declare type ProviderIdentity_3 = OpenFin.ProviderIdentity;
|
|
|
12065
12723
|
* Identity of a channel provider.
|
|
12066
12724
|
* @interface
|
|
12067
12725
|
*/
|
|
12068
|
-
declare type ProviderIdentity_4 =
|
|
12726
|
+
declare type ProviderIdentity_4 = Identity_4 & {
|
|
12069
12727
|
/**
|
|
12070
12728
|
* Identifier of the channel.
|
|
12071
12729
|
*/
|
|
@@ -12076,12 +12734,10 @@ declare type ProviderIdentity_4 = Identity_5 & {
|
|
|
12076
12734
|
channelName: string;
|
|
12077
12735
|
};
|
|
12078
12736
|
|
|
12079
|
-
declare type ProxyConfig = OpenFin.ProxyConfig;
|
|
12080
|
-
|
|
12081
12737
|
/**
|
|
12082
12738
|
* @interface
|
|
12083
12739
|
*/
|
|
12084
|
-
declare type
|
|
12740
|
+
declare type ProxyConfig = {
|
|
12085
12741
|
/**
|
|
12086
12742
|
* The configured proxy address.
|
|
12087
12743
|
*/
|
|
@@ -12093,13 +12749,11 @@ declare type ProxyConfig_2 = {
|
|
|
12093
12749
|
type: string;
|
|
12094
12750
|
};
|
|
12095
12751
|
|
|
12096
|
-
declare type ProxyInfo = OpenFin.ProxyInfo;
|
|
12097
|
-
|
|
12098
12752
|
/**
|
|
12099
12753
|
* @interface
|
|
12100
12754
|
*/
|
|
12101
|
-
declare type
|
|
12102
|
-
config:
|
|
12755
|
+
declare type ProxyInfo = {
|
|
12756
|
+
config: ProxyConfig;
|
|
12103
12757
|
system: ProxySystemInfo;
|
|
12104
12758
|
};
|
|
12105
12759
|
|
|
@@ -12205,12 +12859,10 @@ declare type RegisterUsageData = {
|
|
|
12205
12859
|
type: string;
|
|
12206
12860
|
};
|
|
12207
12861
|
|
|
12208
|
-
declare type RegistryInfo = OpenFin.RegistryInfo;
|
|
12209
|
-
|
|
12210
12862
|
/**
|
|
12211
12863
|
* @interface
|
|
12212
12864
|
*/
|
|
12213
|
-
declare type
|
|
12865
|
+
declare type RegistryInfo = {
|
|
12214
12866
|
data: any;
|
|
12215
12867
|
rootKey: string;
|
|
12216
12868
|
subkey: string;
|
|
@@ -12268,14 +12920,14 @@ declare type ReplaceLayoutPayload = {
|
|
|
12268
12920
|
/**
|
|
12269
12921
|
* Identity of the window whose layout will be replaced.
|
|
12270
12922
|
*/
|
|
12271
|
-
target:
|
|
12923
|
+
target: Identity_4 | LayoutIdentity;
|
|
12272
12924
|
};
|
|
12273
12925
|
|
|
12274
12926
|
/**
|
|
12275
12927
|
* @interface
|
|
12276
12928
|
*/
|
|
12277
12929
|
declare type ReplaceViewOptions = {
|
|
12278
|
-
viewToReplace:
|
|
12930
|
+
viewToReplace: Identity_4;
|
|
12279
12931
|
newView: ViewState;
|
|
12280
12932
|
};
|
|
12281
12933
|
|
|
@@ -12284,7 +12936,7 @@ declare type ReplaceViewOptions = {
|
|
|
12284
12936
|
*/
|
|
12285
12937
|
declare type ReplaceViewPayload = {
|
|
12286
12938
|
opts: {
|
|
12287
|
-
viewToReplace:
|
|
12939
|
+
viewToReplace: Identity_4;
|
|
12288
12940
|
newView: Partial<ViewOptions>;
|
|
12289
12941
|
};
|
|
12290
12942
|
target: LayoutIdentity;
|
|
@@ -12559,6 +13211,21 @@ declare type ScreenshotPrintOptions = {
|
|
|
12559
13211
|
content: 'screenshot';
|
|
12560
13212
|
};
|
|
12561
13213
|
|
|
13214
|
+
/**
|
|
13215
|
+
* An event generated when an application modifies the runtime in a way that affects all other applications in the
|
|
13216
|
+
* application runtime/security realm.
|
|
13217
|
+
*/
|
|
13218
|
+
declare type SecurityRealmEvent = BaseEvent_9 & {
|
|
13219
|
+
/**
|
|
13220
|
+
* Config URL of the application that modified the security realm's extensions
|
|
13221
|
+
*/
|
|
13222
|
+
configUrl: string;
|
|
13223
|
+
/**
|
|
13224
|
+
* Identity of the application that modified the security realm's extensions
|
|
13225
|
+
*/
|
|
13226
|
+
applicationIdentity: OpenFin.ApplicationIdentity;
|
|
13227
|
+
};
|
|
13228
|
+
|
|
12562
13229
|
declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
|
|
12563
13230
|
data: ProtocolMap[T]['response'];
|
|
12564
13231
|
} & ProtocolMap[T]['specialResponse']>;
|
|
@@ -12650,7 +13317,7 @@ declare type SetWindowContextPayload = {
|
|
|
12650
13317
|
/**
|
|
12651
13318
|
* Identity of the entity targeted by the call to {@link Platform#setWindowContext Platform.setWindowContext}.
|
|
12652
13319
|
*/
|
|
12653
|
-
target:
|
|
13320
|
+
target: Identity_4;
|
|
12654
13321
|
};
|
|
12655
13322
|
|
|
12656
13323
|
/**
|
|
@@ -13094,7 +13761,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13094
13761
|
* fin.System.getAllWindows().then(wins => console.log(wins)).catch(err => console.log(err));
|
|
13095
13762
|
* ```
|
|
13096
13763
|
*/
|
|
13097
|
-
getAllWindows(): Promise<Array<ApplicationWindowInfo>>;
|
|
13764
|
+
getAllWindows(): Promise<Array<OpenFin.ApplicationWindowInfo>>;
|
|
13098
13765
|
/**
|
|
13099
13766
|
* Retrieves an array of data for all applications.
|
|
13100
13767
|
*
|
|
@@ -13103,7 +13770,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13103
13770
|
* fin.System.getAllApplications().then(apps => console.log(apps)).catch(err => console.log(err));
|
|
13104
13771
|
* ```
|
|
13105
13772
|
*/
|
|
13106
|
-
getAllApplications(): Promise<Array<ApplicationState>>;
|
|
13773
|
+
getAllApplications(): Promise<Array<OpenFin.ApplicationState>>;
|
|
13107
13774
|
/**
|
|
13108
13775
|
* Retrieves the command line argument string that started OpenFin Runtime.
|
|
13109
13776
|
*
|
|
@@ -13178,7 +13845,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13178
13845
|
* }
|
|
13179
13846
|
* ```
|
|
13180
13847
|
*/
|
|
13181
|
-
getEntityInfo(uuid: string, name: string): Promise<EntityInfo>;
|
|
13848
|
+
getEntityInfo(uuid: string, name: string): Promise<OpenFin.EntityInfo>;
|
|
13182
13849
|
/**
|
|
13183
13850
|
* Gets the value of a given environment variable on the computer on which the runtime is installed
|
|
13184
13851
|
*
|
|
@@ -13220,7 +13887,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13220
13887
|
* ```
|
|
13221
13888
|
*/
|
|
13222
13889
|
getInstalledRuntimes(): Promise<string[]>;
|
|
13223
|
-
getInstalledApps(): Promise<InstalledApps>;
|
|
13890
|
+
getInstalledApps(): Promise<OpenFin.InstalledApps>;
|
|
13224
13891
|
/**
|
|
13225
13892
|
* Retrieves the contents of the log with the specified filename.
|
|
13226
13893
|
* @param options A object that id defined by the GetLogRequestType interface
|
|
@@ -13235,7 +13902,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13235
13902
|
* getLog().then(log => console.log(log)).catch(err => console.log(err));
|
|
13236
13903
|
* ```
|
|
13237
13904
|
*/
|
|
13238
|
-
getLog(options: GetLogRequestType): Promise<string>;
|
|
13905
|
+
getLog(options: OpenFin.GetLogRequestType): Promise<string>;
|
|
13239
13906
|
/**
|
|
13240
13907
|
* Returns a unique identifier (UUID) provided by the machine.
|
|
13241
13908
|
*
|
|
@@ -13253,7 +13920,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13253
13920
|
* fin.System.getMinLogLevel().then(level => console.log(level)).catch(err => console.log(err));
|
|
13254
13921
|
* ```
|
|
13255
13922
|
*/
|
|
13256
|
-
getMinLogLevel(): Promise<LogLevel>;
|
|
13923
|
+
getMinLogLevel(): Promise<OpenFin.LogLevel>;
|
|
13257
13924
|
/**
|
|
13258
13925
|
* Retrieves an array containing information for each log file.
|
|
13259
13926
|
*
|
|
@@ -13262,7 +13929,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13262
13929
|
* fin.System.getLogList().then(logList => console.log(logList)).catch(err => console.log(err));
|
|
13263
13930
|
* ```
|
|
13264
13931
|
*/
|
|
13265
|
-
getLogList(): Promise<Array<LogInfo>>;
|
|
13932
|
+
getLogList(): Promise<Array<OpenFin.LogInfo>>;
|
|
13266
13933
|
/**
|
|
13267
13934
|
* Retrieves an object that contains data about the monitor setup of the
|
|
13268
13935
|
* computer that the runtime is running on.
|
|
@@ -13333,7 +14000,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13333
14000
|
* }
|
|
13334
14001
|
* ```
|
|
13335
14002
|
*/
|
|
13336
|
-
getProxySettings(): Promise<ProxyInfo>;
|
|
14003
|
+
getProxySettings(): Promise<OpenFin.ProxyInfo>;
|
|
13337
14004
|
/**
|
|
13338
14005
|
* Returns information about the running Runtime in an object.
|
|
13339
14006
|
*
|
|
@@ -13700,7 +14367,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13700
14367
|
* }
|
|
13701
14368
|
* ```
|
|
13702
14369
|
*/
|
|
13703
|
-
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<
|
|
14370
|
+
launchExternalProcess(options: OpenFin.ExternalProcessRequestType): Promise<Identity>;
|
|
13704
14371
|
/**
|
|
13705
14372
|
* Monitors a running process. A pid for the process must be included in options.
|
|
13706
14373
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -13717,7 +14384,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13717
14384
|
* }).then(processIdentity => console.log(processIdentity)).catch(err => console.log(err));
|
|
13718
14385
|
* ```
|
|
13719
14386
|
*/
|
|
13720
|
-
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<
|
|
14387
|
+
monitorExternalProcess(options: OpenFin.ExternalProcessInfo): Promise<Identity>;
|
|
13721
14388
|
/**
|
|
13722
14389
|
* Writes the passed message into both the log file and the console.
|
|
13723
14390
|
* @param level The log level for the entry. Can be either "info", "warning" or "error"
|
|
@@ -13851,7 +14518,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13851
14518
|
*
|
|
13852
14519
|
* @tutorial System.showDeveloperTools
|
|
13853
14520
|
*/
|
|
13854
|
-
showDeveloperTools(identity:
|
|
14521
|
+
showDeveloperTools(identity: Identity): Promise<void>;
|
|
13855
14522
|
/**
|
|
13856
14523
|
* Attempt to close an external process. The process will be terminated if it
|
|
13857
14524
|
* has not closed after the elapsed timeout in milliseconds.
|
|
@@ -13885,7 +14552,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13885
14552
|
* .catch(err => console.error(err));
|
|
13886
14553
|
* ```
|
|
13887
14554
|
*/
|
|
13888
|
-
updateProxySettings(options: ProxyConfig): Promise<void>;
|
|
14555
|
+
updateProxySettings(options: OpenFin.ProxyConfig): Promise<void>;
|
|
13889
14556
|
/**
|
|
13890
14557
|
* Downloads the given application asset.
|
|
13891
14558
|
*
|
|
@@ -13977,7 +14644,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
13977
14644
|
* .catch(err => console.log(err));
|
|
13978
14645
|
* ```
|
|
13979
14646
|
*/
|
|
13980
|
-
getAllExternalApplications(): Promise<Array<
|
|
14647
|
+
getAllExternalApplications(): Promise<Array<Identity>>;
|
|
13981
14648
|
/**
|
|
13982
14649
|
* Retrieves app asset information.
|
|
13983
14650
|
* @param options
|
|
@@ -14006,7 +14673,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14006
14673
|
* fin.System.setMinLogLevel("verbose").then(() => console.log("log level is set to verbose")).catch(err => console.log(err));
|
|
14007
14674
|
* ```
|
|
14008
14675
|
*/
|
|
14009
|
-
setMinLogLevel(level: LogLevel): Promise<void>;
|
|
14676
|
+
setMinLogLevel(level: OpenFin.LogLevel): Promise<void>;
|
|
14010
14677
|
/**
|
|
14011
14678
|
* Retrieves the UUID of the computer on which the runtime is installed
|
|
14012
14679
|
* @param uuid The uuid of the running application
|
|
@@ -14016,7 +14683,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14016
14683
|
* fin.System.resolveUuid('OpenfinPOC').then(entity => console.log(entity)).catch(err => console.log(err));
|
|
14017
14684
|
* ```
|
|
14018
14685
|
*/
|
|
14019
|
-
resolveUuid(uuid: string): Promise<
|
|
14686
|
+
resolveUuid(uuid: string): Promise<OpenFin.ApplicationType>;
|
|
14020
14687
|
/**
|
|
14021
14688
|
* Retrieves an array of data for all external applications
|
|
14022
14689
|
* @param requestingIdentity This object is described in the Identity typedef
|
|
@@ -14024,7 +14691,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14024
14691
|
*
|
|
14025
14692
|
* @ignore
|
|
14026
14693
|
*/
|
|
14027
|
-
executeOnRemote(requestingIdentity:
|
|
14694
|
+
executeOnRemote(requestingIdentity: Identity, data: any): Promise<any>;
|
|
14028
14695
|
/**
|
|
14029
14696
|
* Reads the specifed value from the registry.
|
|
14030
14697
|
* @remarks This method is restricted by default and must be enabled via
|
|
@@ -14117,7 +14784,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14117
14784
|
* }
|
|
14118
14785
|
* ```
|
|
14119
14786
|
*/
|
|
14120
|
-
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<RegistryInfo>;
|
|
14787
|
+
readRegistryValue(rootKey: string, subkey: string, value: string): Promise<OpenFin.RegistryInfo>;
|
|
14121
14788
|
/**
|
|
14122
14789
|
* This function call will register a unique id and produce a token.
|
|
14123
14790
|
* The token can be used to broker an external connection.
|
|
@@ -14332,7 +14999,7 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14332
14999
|
* });
|
|
14333
15000
|
* ```
|
|
14334
15001
|
*/
|
|
14335
|
-
getPrinters(): Promise<PrinterInfo[]>;
|
|
15002
|
+
getPrinters(): Promise<OpenFin.PrinterInfo[]>;
|
|
14336
15003
|
/**
|
|
14337
15004
|
* Updates Process Logging values: periodic interval and outlier detection entries and interval.
|
|
14338
15005
|
* @param options Process Logging updatable options.
|
|
@@ -14450,6 +15117,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
|
|
|
14450
15117
|
* ```
|
|
14451
15118
|
*/
|
|
14452
15119
|
setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
|
|
15120
|
+
/**
|
|
15121
|
+
* Attempts to install and enable extensions for the security realm. Users may want to call this function in response
|
|
15122
|
+
* to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
|
|
15123
|
+
* will be installed/enabled.
|
|
15124
|
+
*/
|
|
15125
|
+
refreshExtensions(): Promise<string[] | undefined>;
|
|
15126
|
+
/**
|
|
15127
|
+
* Gets the currently-installed
|
|
15128
|
+
*/
|
|
15129
|
+
getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
|
|
14453
15130
|
}
|
|
14454
15131
|
|
|
14455
15132
|
/**
|
|
@@ -14480,6 +15157,14 @@ declare namespace SystemEvents {
|
|
|
14480
15157
|
ApplicationCreatedEvent,
|
|
14481
15158
|
DesktopIconClickedEvent,
|
|
14482
15159
|
SystemShutdownEvent,
|
|
15160
|
+
ExtensionsEnabledEvent,
|
|
15161
|
+
ExtensionsDisabledEvent,
|
|
15162
|
+
ExtensionsExcludedEvent,
|
|
15163
|
+
ExtensionsInstalledEvent,
|
|
15164
|
+
ExtensionInstalledEvent,
|
|
15165
|
+
ExtensionsInstallFailedEvent,
|
|
15166
|
+
ExtensionInstallFailedEvent,
|
|
15167
|
+
ExtensionsInitializationFailedEvent,
|
|
14483
15168
|
Event_11 as Event,
|
|
14484
15169
|
SystemEvent,
|
|
14485
15170
|
EventType_8 as EventType,
|
|
@@ -14951,14 +15636,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
|
|
|
14951
15636
|
declare type UserAppConfigArgs = Record<string, string | string[]>;
|
|
14952
15637
|
|
|
14953
15638
|
/**
|
|
14954
|
-
*
|
|
15639
|
+
* An event that fires when a window's bounds are changed directly by the user.
|
|
15640
|
+
*
|
|
14955
15641
|
* @interface
|
|
14956
15642
|
*/
|
|
14957
|
-
declare type UserBoundsChangeEvent =
|
|
14958
|
-
height: number;
|
|
14959
|
-
left: number;
|
|
14960
|
-
top: number;
|
|
14961
|
-
width: number;
|
|
15643
|
+
declare type UserBoundsChangeEvent = BoundsEvent & {
|
|
14962
15644
|
windowState: 'minimized' | 'normal' | 'maximized';
|
|
14963
15645
|
};
|
|
14964
15646
|
|
|
@@ -15557,6 +16239,24 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
15557
16239
|
options?: Partial<ViewOptions>;
|
|
15558
16240
|
};
|
|
15559
16241
|
|
|
16242
|
+
/**
|
|
16243
|
+
* @interface
|
|
16244
|
+
*/
|
|
16245
|
+
declare type ViewCreationFailure = {
|
|
16246
|
+
/**
|
|
16247
|
+
* The identity of the created view
|
|
16248
|
+
*/
|
|
16249
|
+
identity: Identity_4;
|
|
16250
|
+
/**
|
|
16251
|
+
* Whether the view was created with errors
|
|
16252
|
+
*/
|
|
16253
|
+
success: false;
|
|
16254
|
+
/**
|
|
16255
|
+
* Error thrown during view creation
|
|
16256
|
+
*/
|
|
16257
|
+
error: Error;
|
|
16258
|
+
};
|
|
16259
|
+
|
|
15560
16260
|
/**
|
|
15561
16261
|
* The options object required by {@link View.ViewModule.create View.create}.
|
|
15562
16262
|
*
|
|
@@ -15567,11 +16267,30 @@ declare type ViewContentCreationRule = BaseContentCreationRule & {
|
|
|
15567
16267
|
declare type ViewCreationOptions = Partial<ViewOptions> & {
|
|
15568
16268
|
name: string;
|
|
15569
16269
|
url: string;
|
|
15570
|
-
target:
|
|
16270
|
+
target: Identity_4;
|
|
15571
16271
|
};
|
|
15572
16272
|
|
|
15573
16273
|
declare type ViewCreationOrReference = OpenFin.Identity | OpenFin.PlatformViewCreationOptions;
|
|
15574
16274
|
|
|
16275
|
+
/**
|
|
16276
|
+
* A view creation state
|
|
16277
|
+
*/
|
|
16278
|
+
declare type ViewCreationResult = ViewCreationSuccess | ViewCreationFailure;
|
|
16279
|
+
|
|
16280
|
+
/**
|
|
16281
|
+
* @interface
|
|
16282
|
+
*/
|
|
16283
|
+
declare type ViewCreationSuccess = {
|
|
16284
|
+
/**
|
|
16285
|
+
* The identity of the created view
|
|
16286
|
+
*/
|
|
16287
|
+
identity: Identity_4;
|
|
16288
|
+
/**
|
|
16289
|
+
* Whether the view was created without errors
|
|
16290
|
+
*/
|
|
16291
|
+
success: true;
|
|
16292
|
+
};
|
|
16293
|
+
|
|
15575
16294
|
/**
|
|
15576
16295
|
* Generated when a window has a view detached from it.
|
|
15577
16296
|
* @remarks Will fire when a view is destroyed in which case `target` will be null.
|
|
@@ -15733,6 +16452,9 @@ declare class ViewModule extends Base {
|
|
|
15733
16452
|
*/
|
|
15734
16453
|
declare type ViewOptions = ConstViewOptions & MutableViewOptions;
|
|
15735
16454
|
|
|
16455
|
+
/**
|
|
16456
|
+
* @interface
|
|
16457
|
+
*/
|
|
15736
16458
|
declare type ViewShowAtOptions = {
|
|
15737
16459
|
/**
|
|
15738
16460
|
* Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
|
|
@@ -15753,15 +16475,15 @@ declare interface ViewsPreventingUnloadPayload {
|
|
|
15753
16475
|
/**
|
|
15754
16476
|
* Identity of the Window.
|
|
15755
16477
|
*/
|
|
15756
|
-
windowId:
|
|
16478
|
+
windowId: Identity_4;
|
|
15757
16479
|
/**
|
|
15758
16480
|
* Identities of the Views that are preventing an unload
|
|
15759
16481
|
*/
|
|
15760
|
-
viewsPreventingUnload:
|
|
16482
|
+
viewsPreventingUnload: Identity_4[];
|
|
15761
16483
|
/**
|
|
15762
16484
|
* Identities of the Views that are not preventing an unload
|
|
15763
16485
|
*/
|
|
15764
|
-
viewsNotPreventingUnload:
|
|
16486
|
+
viewsNotPreventingUnload: Identity_4[];
|
|
15765
16487
|
/**
|
|
15766
16488
|
* Source of the close action.
|
|
15767
16489
|
*/
|
|
@@ -15786,11 +16508,11 @@ declare interface ViewStatuses {
|
|
|
15786
16508
|
/**
|
|
15787
16509
|
* Identities of the Views that are preventing an unload.
|
|
15788
16510
|
*/
|
|
15789
|
-
viewsPreventingUnload:
|
|
16511
|
+
viewsPreventingUnload: Identity_4[];
|
|
15790
16512
|
/**
|
|
15791
16513
|
* Identities of the Views that are not preventing an unload.
|
|
15792
16514
|
*/
|
|
15793
|
-
viewsNotPreventingUnload:
|
|
16515
|
+
viewsNotPreventingUnload: Identity_4[];
|
|
15794
16516
|
}
|
|
15795
16517
|
|
|
15796
16518
|
/**
|
|
@@ -16295,7 +17017,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
16295
17017
|
* We do not expose an explicit superclass for this functionality, but it does have its own
|
|
16296
17018
|
* {@link OpenFin.WebContentsEvents event namespace}.
|
|
16297
17019
|
*/
|
|
16298
|
-
stopFindInPage(action:
|
|
17020
|
+
stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): Promise<void>;
|
|
16299
17021
|
/**
|
|
16300
17022
|
* Returns an array with all system printers
|
|
16301
17023
|
* @deprecated use System.getPrinters instead
|
|
@@ -16888,11 +17610,7 @@ declare type WillMoveEvent = WillMoveOrResizeEvent & {
|
|
|
16888
17610
|
* A general will-move or will-resize event without event type.
|
|
16889
17611
|
* @interface
|
|
16890
17612
|
*/
|
|
16891
|
-
declare type WillMoveOrResizeEvent =
|
|
16892
|
-
height: number;
|
|
16893
|
-
left: number;
|
|
16894
|
-
top: number;
|
|
16895
|
-
width: number;
|
|
17613
|
+
declare type WillMoveOrResizeEvent = BoundsEvent & {
|
|
16896
17614
|
monitorScaleFactor: number;
|
|
16897
17615
|
};
|
|
16898
17616
|
|
|
@@ -18084,16 +18802,21 @@ declare namespace WindowEvents {
|
|
|
18084
18802
|
PreloadScriptInfoRunning,
|
|
18085
18803
|
PreloadScriptInfo,
|
|
18086
18804
|
PreloadScriptsStateChangeEvent,
|
|
18087
|
-
|
|
18805
|
+
BoundsEvent,
|
|
18088
18806
|
BoundsChangeEvent,
|
|
18089
18807
|
WillMoveOrResizeEvent,
|
|
18808
|
+
BoundsDidChangeEvent,
|
|
18809
|
+
BoundsChangedEvent,
|
|
18810
|
+
BoundsChangingEvent,
|
|
18811
|
+
DisabledMovementBoundsChangedEvent,
|
|
18812
|
+
DisabledMovementBoundsChangingEvent,
|
|
18813
|
+
UserBoundsChangeEvent,
|
|
18814
|
+
BeginUserBoundsChangingEvent,
|
|
18815
|
+
EndUserBoundsChangingEvent,
|
|
18090
18816
|
PerformanceReportEvent,
|
|
18091
18817
|
InputEvent_2 as InputEvent,
|
|
18092
18818
|
LayoutInitializedEvent,
|
|
18093
18819
|
LayoutReadyEvent,
|
|
18094
|
-
BeginUserBoundsChangingEvent,
|
|
18095
|
-
BoundsChangedEvent,
|
|
18096
|
-
BoundsChangingEvent,
|
|
18097
18820
|
CloseRequestedEvent,
|
|
18098
18821
|
WindowCloseRequestedEvent,
|
|
18099
18822
|
ContextChangedEvent,
|
|
@@ -18101,10 +18824,7 @@ declare namespace WindowEvents {
|
|
|
18101
18824
|
WindowClosedEvent,
|
|
18102
18825
|
ClosingEvent,
|
|
18103
18826
|
WindowClosingEvent,
|
|
18104
|
-
DisabledMovementBoundsChangedEvent,
|
|
18105
|
-
DisabledMovementBoundsChangingEvent,
|
|
18106
18827
|
EmbeddedEvent,
|
|
18107
|
-
EndUserBoundsChangingEvent,
|
|
18108
18828
|
HotkeyEvent_2 as HotkeyEvent,
|
|
18109
18829
|
WindowHotkeyEvent,
|
|
18110
18830
|
InitializedEvent_2 as InitializedEvent,
|