@openfin/core 39.82.12 → 39.83.1
Sign up to get free protection for your applications and to get access to all the features.
- package/out/mock-alpha.d.ts +160 -55
- package/out/mock-beta.d.ts +160 -55
- package/out/mock-public.d.ts +160 -55
- package/out/mock.d.ts +160 -55
- package/out/mock.js +27 -1
- package/package.json +1 -1
package/out/mock.d.ts
CHANGED
@@ -102,7 +102,7 @@ declare type ApiInjection = DomainApiSettings;
|
|
102
102
|
* Generated when a new Platform's API becomes responsive.
|
103
103
|
* @interface
|
104
104
|
*/
|
105
|
-
declare type ApiReadyEvent = BaseEvent & {
|
105
|
+
declare type ApiReadyEvent = BaseEvents.BaseEvent & {
|
106
106
|
topic: 'application';
|
107
107
|
type: 'platform-api-ready';
|
108
108
|
};
|
@@ -920,7 +920,7 @@ declare namespace ApplicationEvents {
|
|
920
920
|
PropagatedApplicationEvent,
|
921
921
|
PropagatedEventType_3 as PropagatedEventType,
|
922
922
|
PropagatedApplicationEventType,
|
923
|
-
|
923
|
+
Payload_5 as Payload,
|
924
924
|
ByType_3 as ByType
|
925
925
|
}
|
926
926
|
}
|
@@ -1739,7 +1739,7 @@ declare type BaseEvent_10 = Events.BaseEvents.BaseEvent;
|
|
1739
1739
|
* A base Channel event.
|
1740
1740
|
* @interface
|
1741
1741
|
*/
|
1742
|
-
declare type BaseEvent_2 = NamedEvent & {
|
1742
|
+
declare type BaseEvent_2 = BaseEvents.NamedEvent & {
|
1743
1743
|
channelName: string;
|
1744
1744
|
channelId: string;
|
1745
1745
|
};
|
@@ -1809,6 +1809,7 @@ declare namespace BaseEvents {
|
|
1809
1809
|
NotCloseRequested,
|
1810
1810
|
PropagatedEventType,
|
1811
1811
|
PropagatedEvent,
|
1812
|
+
Payload_2 as Payload,
|
1812
1813
|
EventHandler,
|
1813
1814
|
BaseEvent,
|
1814
1815
|
IdentityEvent,
|
@@ -1949,7 +1950,7 @@ declare type BrowserContentCreationRule = BaseContentCreationRule & {
|
|
1949
1950
|
*
|
1950
1951
|
* @typeParam Type String key specifying the event to extract
|
1951
1952
|
*/
|
1952
|
-
declare type ByType<Type extends EventType> =
|
1953
|
+
declare type ByType<Type extends EventType> = Payload_3<Type>;
|
1953
1954
|
|
1954
1955
|
/**
|
1955
1956
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
@@ -1958,7 +1959,7 @@ declare type ByType<Type extends EventType> = Payload_2<Type>;
|
|
1958
1959
|
*
|
1959
1960
|
* @typeParam Type String key specifying the event to extract
|
1960
1961
|
*/
|
1961
|
-
declare type ByType_2<Type extends EventType_2> =
|
1962
|
+
declare type ByType_2<Type extends EventType_2> = Payload_4<Type>;
|
1962
1963
|
|
1963
1964
|
/**
|
1964
1965
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
@@ -1967,7 +1968,7 @@ declare type ByType_2<Type extends EventType_2> = Payload_3<Type>;
|
|
1967
1968
|
*
|
1968
1969
|
* @typeParam Type String key specifying the event to extract
|
1969
1970
|
*/
|
1970
|
-
declare type ByType_3<Type extends EventType_3> =
|
1971
|
+
declare type ByType_3<Type extends EventType_3> = Payload_5<Type>;
|
1971
1972
|
|
1972
1973
|
/**
|
1973
1974
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
@@ -1976,7 +1977,7 @@ declare type ByType_3<Type extends EventType_3> = Payload_4<Type>;
|
|
1976
1977
|
*
|
1977
1978
|
* @typeParam Type String key specifying the event to extract
|
1978
1979
|
*/
|
1979
|
-
declare type ByType_4<Type extends EventType_4> =
|
1980
|
+
declare type ByType_4<Type extends EventType_4> = Payload_6<Type>;
|
1980
1981
|
|
1981
1982
|
/**
|
1982
1983
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
@@ -1985,7 +1986,7 @@ declare type ByType_4<Type extends EventType_4> = Payload_5<Type>;
|
|
1985
1986
|
*
|
1986
1987
|
* @typeParam Type String key specifying the event to extract
|
1987
1988
|
*/
|
1988
|
-
declare type ByType_5<Type extends EventType_5> =
|
1989
|
+
declare type ByType_5<Type extends EventType_5> = Payload_7<Type>;
|
1989
1990
|
|
1990
1991
|
/**
|
1991
1992
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
@@ -1994,7 +1995,7 @@ declare type ByType_5<Type extends EventType_5> = Payload_6<Type>;
|
|
1994
1995
|
*
|
1995
1996
|
* @typeParam Type String key specifying the event to extract
|
1996
1997
|
*/
|
1997
|
-
declare type ByType_6<Type extends EventType_6> =
|
1998
|
+
declare type ByType_6<Type extends EventType_6> = Payload_8<Type>;
|
1998
1999
|
|
1999
2000
|
/**
|
2000
2001
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
@@ -2003,7 +2004,7 @@ declare type ByType_6<Type extends EventType_6> = Payload_7<Type>;
|
|
2003
2004
|
*
|
2004
2005
|
* @typeParam Type String key specifying the event to extract
|
2005
2006
|
*/
|
2006
|
-
declare type ByType_7<Type extends EventType_7> =
|
2007
|
+
declare type ByType_7<Type extends EventType_7> = Payload_9<Type>;
|
2007
2008
|
|
2008
2009
|
/**
|
2009
2010
|
* Extracts a single event type matching the given key from the System {@link Event} union.
|
@@ -2012,7 +2013,7 @@ declare type ByType_7<Type extends EventType_7> = Payload_8<Type>;
|
|
2012
2013
|
*
|
2013
2014
|
* @typeParam Type String key specifying the event to extract
|
2014
2015
|
*/
|
2015
|
-
declare type ByType_8<Type extends EventType_8> =
|
2016
|
+
declare type ByType_8<Type extends EventType_8> = Payload_10<Type>;
|
2016
2017
|
|
2017
2018
|
/**
|
2018
2019
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
@@ -2021,7 +2022,7 @@ declare type ByType_8<Type extends EventType_8> = Payload_9<Type>;
|
|
2021
2022
|
*
|
2022
2023
|
* @typeParam Type String key specifying the event to extract
|
2023
2024
|
*/
|
2024
|
-
declare type ByType_9<Type extends EventType_9> =
|
2025
|
+
declare type ByType_9<Type extends EventType_9> = Payload_11<Type>;
|
2025
2026
|
|
2026
2027
|
/**
|
2027
2028
|
* Configuration for page capture.
|
@@ -3760,6 +3761,7 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
3760
3761
|
|
3761
3762
|
/**
|
3762
3763
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
3764
|
+
* @interface
|
3763
3765
|
*/
|
3764
3766
|
declare type ContentBlockedEvent = NamedEvent & {
|
3765
3767
|
type: 'content-blocked';
|
@@ -4416,6 +4418,10 @@ declare type DomainSettingsRule = {
|
|
4416
4418
|
* Settings applied when a webcontents has been navigated to a matched domain.
|
4417
4419
|
*/
|
4418
4420
|
options: PerDomainSettings;
|
4421
|
+
/**
|
4422
|
+
* Options to use when comparing URIs to the `match` patterns.
|
4423
|
+
*/
|
4424
|
+
matchOptions?: RuleMatchOptions;
|
4419
4425
|
};
|
4420
4426
|
|
4421
4427
|
/**
|
@@ -4865,9 +4871,7 @@ declare class EventAggregator extends EmitterMap {
|
|
4865
4871
|
* @remarks Selects the correct type for the event
|
4866
4872
|
* payload from the provided union based on the provided string literal type.
|
4867
4873
|
*/
|
4868
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
4869
|
-
type: EventType;
|
4870
|
-
}>, ...args: any[]) => void;
|
4874
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
|
4871
4875
|
|
4872
4876
|
declare namespace Events {
|
4873
4877
|
export {
|
@@ -5024,7 +5028,7 @@ declare namespace ExternalApplicationEvents {
|
|
5024
5028
|
ExternalApplicationEvent,
|
5025
5029
|
EventType_4 as EventType,
|
5026
5030
|
ExternalApplicationEventType,
|
5027
|
-
|
5031
|
+
Payload_6 as Payload,
|
5028
5032
|
ByType_4 as ByType
|
5029
5033
|
}
|
5030
5034
|
}
|
@@ -5479,7 +5483,7 @@ declare namespace FrameEvents {
|
|
5479
5483
|
FrameEvent,
|
5480
5484
|
EventType_5 as EventType,
|
5481
5485
|
FrameEventType,
|
5482
|
-
|
5486
|
+
Payload_7 as Payload,
|
5483
5487
|
ByType_5 as ByType
|
5484
5488
|
}
|
5485
5489
|
}
|
@@ -5722,7 +5726,7 @@ declare namespace GlobalHotkeyEvents {
|
|
5722
5726
|
GlobalHotkeyEvent,
|
5723
5727
|
EventType_6 as EventType,
|
5724
5728
|
GlobalHotkeyEventType,
|
5725
|
-
|
5729
|
+
Payload_8 as Payload,
|
5726
5730
|
ByType_6 as ByType
|
5727
5731
|
}
|
5728
5732
|
}
|
@@ -7834,7 +7838,7 @@ declare namespace LayoutDOMEvents {
|
|
7834
7838
|
LayoutStateChangedEvent,
|
7835
7839
|
Event_12 as Event,
|
7836
7840
|
EventType_9 as EventType,
|
7837
|
-
|
7841
|
+
Payload_11 as Payload,
|
7838
7842
|
ByType_9 as ByType
|
7839
7843
|
}
|
7840
7844
|
}
|
@@ -9203,10 +9207,42 @@ declare type NavigationRules = {
|
|
9203
9207
|
allowlist?: string[];
|
9204
9208
|
/** Forbidden URLs for navigation. */
|
9205
9209
|
denylist?: string[];
|
9210
|
+
/**
|
9211
|
+
* Options to use when comparing URIs to the `allowlist` and `denylist` patterns.
|
9212
|
+
*/
|
9213
|
+
matchOptions?: RuleMatchOptions;
|
9206
9214
|
};
|
9207
9215
|
|
9208
9216
|
declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
|
9209
9217
|
|
9218
|
+
declare interface NodeNetworkInterfaceBase {
|
9219
|
+
address: string;
|
9220
|
+
netmask: string;
|
9221
|
+
mac: string;
|
9222
|
+
internal: boolean;
|
9223
|
+
cidr: string | null;
|
9224
|
+
}
|
9225
|
+
|
9226
|
+
declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
|
9227
|
+
|
9228
|
+
declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
|
9229
|
+
family: 'IPv4';
|
9230
|
+
scopeid?: undefined;
|
9231
|
+
}
|
9232
|
+
|
9233
|
+
declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
|
9234
|
+
family: 'IPv6';
|
9235
|
+
scopeid: number;
|
9236
|
+
}
|
9237
|
+
|
9238
|
+
declare interface NodeUserInfo {
|
9239
|
+
username: string;
|
9240
|
+
uid: number;
|
9241
|
+
gid: number;
|
9242
|
+
shell: string | null;
|
9243
|
+
homedir: string;
|
9244
|
+
}
|
9245
|
+
|
9210
9246
|
/**
|
9211
9247
|
* @interface
|
9212
9248
|
*/
|
@@ -9362,6 +9398,7 @@ declare namespace OpenFin_2 {
|
|
9362
9398
|
Api,
|
9363
9399
|
ApiSettings,
|
9364
9400
|
InjectionType,
|
9401
|
+
RuleMatchOptions,
|
9365
9402
|
NavigationRules,
|
9366
9403
|
ContentNavigation,
|
9367
9404
|
ContentRedirect,
|
@@ -9445,6 +9482,7 @@ declare namespace OpenFin_2 {
|
|
9445
9482
|
Time,
|
9446
9483
|
CpuInfo,
|
9447
9484
|
GpuInfo,
|
9485
|
+
OSInfo,
|
9448
9486
|
HostSpecs,
|
9449
9487
|
PrinterInfo_2 as PrinterInfo,
|
9450
9488
|
Dpi,
|
@@ -9654,6 +9692,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
|
|
9654
9692
|
diff: OpenFin_2.WindowOptionDiff;
|
9655
9693
|
};
|
9656
9694
|
|
9695
|
+
/**
|
9696
|
+
* @interface
|
9697
|
+
* The keys represent the output from calling individual Node `os` APIs.
|
9698
|
+
* For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
|
9699
|
+
* see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
|
9700
|
+
*/
|
9701
|
+
declare type OSInfo = {
|
9702
|
+
platform: string;
|
9703
|
+
release: string;
|
9704
|
+
version: string;
|
9705
|
+
/**
|
9706
|
+
* Throws if a user has no username or homedir.
|
9707
|
+
* See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
|
9708
|
+
*/
|
9709
|
+
userInfo: NodeUserInfo;
|
9710
|
+
hostname: string;
|
9711
|
+
networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
|
9712
|
+
};
|
9713
|
+
|
9657
9714
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
9658
9715
|
|
9659
9716
|
/**
|
@@ -9682,86 +9739,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
9682
9739
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
9683
9740
|
};
|
9684
9741
|
|
9742
|
+
/**
|
9743
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9744
|
+
*
|
9745
|
+
* @see {@link ByType}
|
9746
|
+
*
|
9747
|
+
* @typeParam Type String key specifying the event to extract
|
9748
|
+
*/
|
9749
|
+
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
9750
|
+
|
9685
9751
|
/**
|
9686
9752
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
9687
9753
|
*
|
9688
9754
|
* @typeParam Type String key specifying the event to extract
|
9689
9755
|
*/
|
9690
|
-
declare type
|
9756
|
+
declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
|
9691
9757
|
type: Type;
|
9692
9758
|
}>;
|
9693
9759
|
|
9760
|
+
/**
|
9761
|
+
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
9762
|
+
*
|
9763
|
+
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
9764
|
+
* the appropriate payload union for that namespace.
|
9765
|
+
*
|
9766
|
+
* @typeParam Event Union of payloads for events on the given emitter
|
9767
|
+
* @see {@link ByType}
|
9768
|
+
*
|
9769
|
+
* @typeParam Type String key specifying the event to extract from the union
|
9770
|
+
*
|
9771
|
+
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
9772
|
+
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
9773
|
+
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
9774
|
+
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
9775
|
+
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
9776
|
+
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
9777
|
+
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
9778
|
+
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
9779
|
+
*/
|
9780
|
+
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
9781
|
+
type: EventType;
|
9782
|
+
}>;
|
9783
|
+
|
9694
9784
|
/**
|
9695
9785
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
9696
9786
|
*
|
9787
|
+
* @see {@link ByType}
|
9788
|
+
*
|
9697
9789
|
* @typeParam Type String key specifying the event to extract
|
9698
9790
|
*/
|
9699
|
-
declare type
|
9700
|
-
type: Type;
|
9701
|
-
}>;
|
9791
|
+
declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
|
9702
9792
|
|
9703
9793
|
/**
|
9704
9794
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
9705
9795
|
*
|
9796
|
+
* @see {@link ByType}
|
9797
|
+
*
|
9706
9798
|
* @typeParam Type String key specifying the event to extract
|
9707
9799
|
*/
|
9708
|
-
declare type
|
9709
|
-
type: Type;
|
9710
|
-
}>;
|
9800
|
+
declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
|
9711
9801
|
|
9712
9802
|
/**
|
9713
9803
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
9714
9804
|
*
|
9805
|
+
* @see {@link ByType}
|
9806
|
+
*
|
9715
9807
|
* @typeParam Type String key specifying the event to extract
|
9716
9808
|
*/
|
9717
|
-
declare type
|
9718
|
-
type: Type;
|
9719
|
-
}>;
|
9809
|
+
declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
|
9720
9810
|
|
9721
9811
|
/**
|
9722
9812
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
9723
9813
|
*
|
9814
|
+
* @see {@link ByType}
|
9815
|
+
*
|
9724
9816
|
* @typeParam Type String key specifying the event to extract
|
9725
9817
|
*/
|
9726
|
-
declare type
|
9727
|
-
type: Type;
|
9728
|
-
}>;
|
9818
|
+
declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
|
9729
9819
|
|
9730
9820
|
/**
|
9731
9821
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
9732
9822
|
*
|
9823
|
+
* @see {@link ByType}
|
9824
|
+
*
|
9733
9825
|
* @typeParam Type String key specifying the event to extract
|
9734
9826
|
*/
|
9735
|
-
declare type
|
9736
|
-
type: Type;
|
9737
|
-
}>;
|
9827
|
+
declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
|
9738
9828
|
|
9739
9829
|
/**
|
9740
9830
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
9741
9831
|
*
|
9832
|
+
* @see {@link ByType}
|
9833
|
+
*
|
9742
9834
|
* @typeParam Type String key specifying the event to extract
|
9743
9835
|
*/
|
9744
|
-
declare type
|
9745
|
-
type: Type;
|
9746
|
-
}>;
|
9836
|
+
declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
|
9747
9837
|
|
9748
9838
|
/**
|
9749
9839
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
9750
9840
|
*
|
9751
|
-
* @
|
9752
|
-
*/
|
9753
|
-
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
9754
|
-
type: Type;
|
9755
|
-
}>;
|
9756
|
-
|
9757
|
-
/**
|
9758
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
9841
|
+
* @see {@link ByType}
|
9759
9842
|
*
|
9760
9843
|
* @typeParam Type String key specifying the event to extract
|
9761
9844
|
*/
|
9762
|
-
declare type Payload_9<Type extends
|
9763
|
-
type: Type;
|
9764
|
-
}>;
|
9845
|
+
declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
|
9765
9846
|
|
9766
9847
|
/**
|
9767
9848
|
* @interface
|
@@ -10486,7 +10567,7 @@ declare namespace PlatformEvents {
|
|
10486
10567
|
PlatformEvent,
|
10487
10568
|
EventType_7 as EventType,
|
10488
10569
|
PlatformEventType,
|
10489
|
-
|
10570
|
+
Payload_9 as Payload,
|
10490
10571
|
ByType_7 as ByType
|
10491
10572
|
}
|
10492
10573
|
}
|
@@ -11969,6 +12050,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
11969
12050
|
};
|
11970
12051
|
response: void;
|
11971
12052
|
};
|
12053
|
+
'get-host-specs': GetterCall<OpenFin_2.HostSpecs>;
|
12054
|
+
'get-os-info': GetterCall<OpenFin_2.OSInfo>;
|
11972
12055
|
'system-get-printers': GetterCall<OpenFin_2.PrinterInfo[]>;
|
11973
12056
|
'system-register-shutdown-handler': VoidCall;
|
11974
12057
|
'get-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.DefaultDomainSettings>;
|
@@ -12362,6 +12445,17 @@ declare interface RTCProtocolOffer extends ProtocolPacketBase {
|
|
12362
12445
|
};
|
12363
12446
|
}
|
12364
12447
|
|
12448
|
+
/**
|
12449
|
+
* Controls the behavior of the navigation URI pattern matching algorithm.
|
12450
|
+
*/
|
12451
|
+
declare type RuleMatchOptions = {
|
12452
|
+
/**
|
12453
|
+
* Matches all schemes rather than just http and https when a wild card is specified. For example, `'*://*.site.com'` will
|
12454
|
+
* only match urls which begin with `'http:'` or `'https:'` unless this setting is `true`.
|
12455
|
+
*/
|
12456
|
+
matchAllSchemes?: boolean;
|
12457
|
+
};
|
12458
|
+
|
12365
12459
|
declare type RunRequestedEvent = OpenFin_2.ApplicationEvents.RunRequestedEvent;
|
12366
12460
|
|
12367
12461
|
/**
|
@@ -12814,7 +12908,7 @@ declare type Snapshot = {
|
|
12814
12908
|
* _Note_ - In the case of using a custom provider, if a window has a layout property but does not call _Layout.init_ this event may not fire.
|
12815
12909
|
* @interface
|
12816
12910
|
*/
|
12817
|
-
declare type SnapshotAppliedEvent = BaseEvent & {
|
12911
|
+
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
12818
12912
|
topic: 'application';
|
12819
12913
|
type: 'platform-snapshot-applied';
|
12820
12914
|
};
|
@@ -13304,7 +13398,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
13304
13398
|
*/
|
13305
13399
|
getRvmInfo(): Promise<OpenFin_2.RVMInfo>;
|
13306
13400
|
/**
|
13307
|
-
* Retrieves system information.
|
13401
|
+
* Retrieves general system information. If you need more detailed information about the
|
13402
|
+
* OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
|
13308
13403
|
*
|
13309
13404
|
* @example
|
13310
13405
|
* ```js
|
@@ -13312,6 +13407,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
13312
13407
|
* ```
|
13313
13408
|
*/
|
13314
13409
|
getHostSpecs(): Promise<OpenFin_2.HostSpecs>;
|
13410
|
+
/**
|
13411
|
+
* Retrieves information about the OS and the currently logged in user.
|
13412
|
+
*
|
13413
|
+
* @example
|
13414
|
+
* ```js
|
13415
|
+
* fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
|
13416
|
+
* ```
|
13417
|
+
*/
|
13418
|
+
getOSInfo(): Promise<OpenFin_2.OSInfo>;
|
13315
13419
|
/**
|
13316
13420
|
* Runs an executable or batch file. A path to the file must be included in options.
|
13317
13421
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
@@ -14425,7 +14529,7 @@ declare namespace SystemEvents {
|
|
14425
14529
|
SystemEvent,
|
14426
14530
|
EventType_8 as EventType,
|
14427
14531
|
SystemEventType,
|
14428
|
-
|
14532
|
+
Payload_10 as Payload,
|
14429
14533
|
ByType_8 as ByType
|
14430
14534
|
}
|
14431
14535
|
}
|
@@ -14439,6 +14543,7 @@ declare type SystemEventType = EventType_8;
|
|
14439
14543
|
* @interface
|
14440
14544
|
*/
|
14441
14545
|
declare type SystemPermissions = {
|
14546
|
+
getOSInfo: boolean;
|
14442
14547
|
getAllExternalWindows: boolean;
|
14443
14548
|
launchExternalProcess: boolean | {
|
14444
14549
|
enabled: boolean;
|
@@ -15490,7 +15595,7 @@ declare namespace ViewEvents {
|
|
15490
15595
|
PropagatedViewEvent,
|
15491
15596
|
PropagatedEventType_2 as PropagatedEventType,
|
15492
15597
|
PropagatedViewEventType,
|
15493
|
-
|
15598
|
+
Payload_3 as Payload,
|
15494
15599
|
ByType
|
15495
15600
|
}
|
15496
15601
|
}
|
@@ -18014,7 +18119,7 @@ declare namespace WindowEvents {
|
|
18014
18119
|
PropagatedEvent_3 as PropagatedEvent,
|
18015
18120
|
PropagatedWindowEvent,
|
18016
18121
|
PropagatedWindowEventType,
|
18017
|
-
|
18122
|
+
Payload_4 as Payload,
|
18018
18123
|
ByType_2 as ByType
|
18019
18124
|
}
|
18020
18125
|
}
|
package/out/mock.js
CHANGED
@@ -38,6 +38,8 @@ var application$1 = {};
|
|
38
38
|
* For example, a view's "attached" event will fire as 'window-view-attached' at the application level.
|
39
39
|
*
|
40
40
|
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
41
|
+
* Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces. To refer to the full type
|
42
|
+
* of an event as it would be raised on this emitter, use {@link Payload}.
|
41
43
|
*
|
42
44
|
* This namespace contains only payload shapes for events that are unique to `Application`. Events that propagate to `Application` from
|
43
45
|
* child {@link OpenFin.Window windows} and {@link OpenFin.View views} are defined in the {@link OpenFin.WindowEvents} and
|
@@ -69,6 +71,8 @@ var externalApplication$1 = {};
|
|
69
71
|
* Namespace for events that can be transmitted by an {@link OpenFin.ExternalApplication}.
|
70
72
|
*
|
71
73
|
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
74
|
+
* Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces. To refer to the full type
|
75
|
+
* of an event as it would be raised on this emitter, use {@link Payload}.
|
72
76
|
*
|
73
77
|
* For a list of valid string keys for external application events, see {@link ExternalApplication.on ExternalApplication.on}.
|
74
78
|
*
|
@@ -87,6 +91,8 @@ var globalHotkey$1 = {};
|
|
87
91
|
* Namespace for events that can be transmitted by {@link GlobalHotkey.GlobalHotkey}.
|
88
92
|
*
|
89
93
|
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
94
|
+
* Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces. To refer to the full type
|
95
|
+
* of an event as it would be raised on this emitter, use {@link Payload}.
|
90
96
|
*
|
91
97
|
* For a list of valid string keys for global hotkey events, see {@link GlobalHotkey.GlobalHotkey.on GlobalHotkey.on}.
|
92
98
|
*
|
@@ -101,6 +107,8 @@ var platform$1 = {};
|
|
101
107
|
* Namespace for events that can emitted by a {@link OpenFin.Platform}.
|
102
108
|
*
|
103
109
|
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
110
|
+
* Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces. To refer to the full type
|
111
|
+
* of an event as it would be raised on this emitter, use {@link Payload}.
|
104
112
|
*
|
105
113
|
* The Platform `EventEmitter` is a superset of the {@link OpenFin.Application} `EventEmitter`,
|
106
114
|
* meaning it can listen to all {@link OpenFin.ApplicationEvents Application events} in addition to the
|
@@ -122,6 +130,8 @@ var system$1 = {};
|
|
122
130
|
* will be visible as 'view-shown' at the system level, but *not* as `application-window-view-shown`.
|
123
131
|
*
|
124
132
|
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
133
|
+
* Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces. To refer to the full type
|
134
|
+
* of an event as it would be raised on this emitter, use {@link Payload}.
|
125
135
|
*
|
126
136
|
* This namespace contains only payload shapes for events that are unique to `System`. Events that propagate to `System` from
|
127
137
|
* child {@link OpenFin.Application applications}, {@link OpenFin.Window windows}, and {@link OpenFin.View views} are defined in the
|
@@ -138,6 +148,8 @@ var view$1 = {};
|
|
138
148
|
* Namespace for events that can be emitted by a {@link OpenFin.View}.
|
139
149
|
*
|
140
150
|
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
151
|
+
* Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces. To refer to the full type
|
152
|
+
* of an event as it would be raised on this emitter, use {@link Payload}.
|
141
153
|
*
|
142
154
|
* This namespace contains only payload shapes for events that are unique to `View`. Events that are shared between all `WebContents`
|
143
155
|
* (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. For a list
|
@@ -169,6 +181,8 @@ var window$2 = {};
|
|
169
181
|
* Namespace for events that can be emitted by a {@link OpenFin.Window}.
|
170
182
|
*
|
171
183
|
* Event payloads are documented as interfaces, while algebraic helper types and derived types are documented as type aliases.
|
184
|
+
* Events gain metadata as they propagate, which is *not* present on the explicit payload interfaces. To refer to the full type
|
185
|
+
* of an event as it would be raised on this emitter, use {@link Payload}.
|
172
186
|
*
|
173
187
|
* This namespace contains only payload shapes for events that are unique to `Window`. Events that are shared between all `WebContents`
|
174
188
|
* (i.e. {@link OpenFin.Window}, {@link OpenFin.View}) are defined in {@link OpenFin.WebContentsEvents}. Events that
|
@@ -6379,7 +6393,8 @@ class System extends base_1$i.EmitterBase {
|
|
6379
6393
|
return this.wire.sendAction('get-rvm-info').then(({ payload }) => payload.data);
|
6380
6394
|
}
|
6381
6395
|
/**
|
6382
|
-
* Retrieves system information.
|
6396
|
+
* Retrieves general system information. If you need more detailed information about the
|
6397
|
+
* OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
|
6383
6398
|
*
|
6384
6399
|
* @example
|
6385
6400
|
* ```js
|
@@ -6389,6 +6404,17 @@ class System extends base_1$i.EmitterBase {
|
|
6389
6404
|
getHostSpecs() {
|
6390
6405
|
return this.wire.sendAction('get-host-specs').then(({ payload }) => payload.data);
|
6391
6406
|
}
|
6407
|
+
/**
|
6408
|
+
* Retrieves information about the OS and the currently logged in user.
|
6409
|
+
*
|
6410
|
+
* @example
|
6411
|
+
* ```js
|
6412
|
+
* fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
|
6413
|
+
* ```
|
6414
|
+
*/
|
6415
|
+
getOSInfo() {
|
6416
|
+
return this.wire.sendAction('get-os-info').then(({ payload }) => payload.data);
|
6417
|
+
}
|
6392
6418
|
/**
|
6393
6419
|
* Runs an executable or batch file. A path to the file must be included in options.
|
6394
6420
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|