@openfin/core 39.82.13 → 39.83.2
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/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';
|
|
@@ -4869,9 +4871,7 @@ declare class EventAggregator extends EmitterMap {
|
|
|
4869
4871
|
* @remarks Selects the correct type for the event
|
|
4870
4872
|
* payload from the provided union based on the provided string literal type.
|
|
4871
4873
|
*/
|
|
4872
|
-
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload:
|
|
4873
|
-
type: EventType;
|
|
4874
|
-
}>, ...args: any[]) => void;
|
|
4874
|
+
declare type EventHandler<EmitterEvent extends BaseEvent, EventType extends string> = (payload: Payload_2<EmitterEvent, EventType>, ...args: any[]) => void;
|
|
4875
4875
|
|
|
4876
4876
|
declare namespace Events {
|
|
4877
4877
|
export {
|
|
@@ -5028,7 +5028,7 @@ declare namespace ExternalApplicationEvents {
|
|
|
5028
5028
|
ExternalApplicationEvent,
|
|
5029
5029
|
EventType_4 as EventType,
|
|
5030
5030
|
ExternalApplicationEventType,
|
|
5031
|
-
|
|
5031
|
+
Payload_6 as Payload,
|
|
5032
5032
|
ByType_4 as ByType
|
|
5033
5033
|
}
|
|
5034
5034
|
}
|
|
@@ -5483,7 +5483,7 @@ declare namespace FrameEvents {
|
|
|
5483
5483
|
FrameEvent,
|
|
5484
5484
|
EventType_5 as EventType,
|
|
5485
5485
|
FrameEventType,
|
|
5486
|
-
|
|
5486
|
+
Payload_7 as Payload,
|
|
5487
5487
|
ByType_5 as ByType
|
|
5488
5488
|
}
|
|
5489
5489
|
}
|
|
@@ -5726,7 +5726,7 @@ declare namespace GlobalHotkeyEvents {
|
|
|
5726
5726
|
GlobalHotkeyEvent,
|
|
5727
5727
|
EventType_6 as EventType,
|
|
5728
5728
|
GlobalHotkeyEventType,
|
|
5729
|
-
|
|
5729
|
+
Payload_8 as Payload,
|
|
5730
5730
|
ByType_6 as ByType
|
|
5731
5731
|
}
|
|
5732
5732
|
}
|
|
@@ -7838,7 +7838,7 @@ declare namespace LayoutDOMEvents {
|
|
|
7838
7838
|
LayoutStateChangedEvent,
|
|
7839
7839
|
Event_12 as Event,
|
|
7840
7840
|
EventType_9 as EventType,
|
|
7841
|
-
|
|
7841
|
+
Payload_11 as Payload,
|
|
7842
7842
|
ByType_9 as ByType
|
|
7843
7843
|
}
|
|
7844
7844
|
}
|
|
@@ -8514,6 +8514,23 @@ declare type LogLevel = OpenFin_2.LogLevel;
|
|
|
8514
8514
|
*/
|
|
8515
8515
|
declare type LogLevel_2 = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
|
|
8516
8516
|
|
|
8517
|
+
declare type LogUploaderUIOptions = {
|
|
8518
|
+
title?: string;
|
|
8519
|
+
icon?: string;
|
|
8520
|
+
header?: string;
|
|
8521
|
+
description?: string;
|
|
8522
|
+
email?: string;
|
|
8523
|
+
website?: string;
|
|
8524
|
+
websiteDescription?: string;
|
|
8525
|
+
};
|
|
8526
|
+
|
|
8527
|
+
declare type LogUploadOptions = {
|
|
8528
|
+
endpoint: string;
|
|
8529
|
+
manifests?: string[];
|
|
8530
|
+
logs?: string[];
|
|
8531
|
+
ui?: LogUploaderUIOptions;
|
|
8532
|
+
};
|
|
8533
|
+
|
|
8517
8534
|
/**
|
|
8518
8535
|
* @interface
|
|
8519
8536
|
*/
|
|
@@ -8572,6 +8589,7 @@ declare type Manifest = {
|
|
|
8572
8589
|
enableErrorReporting?: boolean;
|
|
8573
8590
|
};
|
|
8574
8591
|
interopBrokerConfiguration: InteropBrokerOptions;
|
|
8592
|
+
logUpload?: LogUploadOptions;
|
|
8575
8593
|
};
|
|
8576
8594
|
|
|
8577
8595
|
/**
|
|
@@ -9215,6 +9233,34 @@ declare type NavigationRules = {
|
|
|
9215
9233
|
|
|
9216
9234
|
declare type NewConnectConfig = ConfigWithUuid & ConfigWithRuntime;
|
|
9217
9235
|
|
|
9236
|
+
declare interface NodeNetworkInterfaceBase {
|
|
9237
|
+
address: string;
|
|
9238
|
+
netmask: string;
|
|
9239
|
+
mac: string;
|
|
9240
|
+
internal: boolean;
|
|
9241
|
+
cidr: string | null;
|
|
9242
|
+
}
|
|
9243
|
+
|
|
9244
|
+
declare type NodeNetworkInterfaceInfo = NodeNetworkInterfaceInfoIPv4 | NodeNetworkInterfaceInfoIPv6;
|
|
9245
|
+
|
|
9246
|
+
declare interface NodeNetworkInterfaceInfoIPv4 extends NodeNetworkInterfaceBase {
|
|
9247
|
+
family: 'IPv4';
|
|
9248
|
+
scopeid?: undefined;
|
|
9249
|
+
}
|
|
9250
|
+
|
|
9251
|
+
declare interface NodeNetworkInterfaceInfoIPv6 extends NodeNetworkInterfaceBase {
|
|
9252
|
+
family: 'IPv6';
|
|
9253
|
+
scopeid: number;
|
|
9254
|
+
}
|
|
9255
|
+
|
|
9256
|
+
declare interface NodeUserInfo {
|
|
9257
|
+
username: string;
|
|
9258
|
+
uid: number;
|
|
9259
|
+
gid: number;
|
|
9260
|
+
shell: string | null;
|
|
9261
|
+
homedir: string;
|
|
9262
|
+
}
|
|
9263
|
+
|
|
9218
9264
|
/**
|
|
9219
9265
|
* @interface
|
|
9220
9266
|
*/
|
|
@@ -9427,6 +9473,8 @@ declare namespace OpenFin_2 {
|
|
|
9427
9473
|
PlatformViewCreationOptions,
|
|
9428
9474
|
ProcessAffinityStrategy,
|
|
9429
9475
|
PlatformOptions,
|
|
9476
|
+
LogUploaderUIOptions,
|
|
9477
|
+
LogUploadOptions,
|
|
9430
9478
|
Manifest,
|
|
9431
9479
|
LayoutContent,
|
|
9432
9480
|
LayoutItemConfig,
|
|
@@ -9454,6 +9502,7 @@ declare namespace OpenFin_2 {
|
|
|
9454
9502
|
Time,
|
|
9455
9503
|
CpuInfo,
|
|
9456
9504
|
GpuInfo,
|
|
9505
|
+
OSInfo,
|
|
9457
9506
|
HostSpecs,
|
|
9458
9507
|
PrinterInfo_2 as PrinterInfo,
|
|
9459
9508
|
Dpi,
|
|
@@ -9663,6 +9712,25 @@ declare type OptionsChangedEvent = BaseEvent_5 & {
|
|
|
9663
9712
|
diff: OpenFin_2.WindowOptionDiff;
|
|
9664
9713
|
};
|
|
9665
9714
|
|
|
9715
|
+
/**
|
|
9716
|
+
* @interface
|
|
9717
|
+
* The keys represent the output from calling individual Node `os` APIs.
|
|
9718
|
+
* For example, `userInfo` will have the output of calling `os.userInfo()`. For more information
|
|
9719
|
+
* see [Node `os` API docs](https://nodejs.org/docs/latest-v20.x/api/os.html)
|
|
9720
|
+
*/
|
|
9721
|
+
declare type OSInfo = {
|
|
9722
|
+
platform: string;
|
|
9723
|
+
release: string;
|
|
9724
|
+
version: string;
|
|
9725
|
+
/**
|
|
9726
|
+
* Throws if a user has no username or homedir.
|
|
9727
|
+
* See [Node os.userInfo docs for more info](https://nodejs.org/docs/latest-v20.x/api/os.html#osuserinfooptions)
|
|
9728
|
+
*/
|
|
9729
|
+
userInfo: NodeUserInfo;
|
|
9730
|
+
hostname: string;
|
|
9731
|
+
networkInterfaces: Record<string, NodeNetworkInterfaceInfo[] | undefined>;
|
|
9732
|
+
};
|
|
9733
|
+
|
|
9666
9734
|
declare type OverrideCallback<T extends any = PlatformProvider, U extends T = T> = (arg: Constructor<T>) => U | Promise<U>;
|
|
9667
9735
|
|
|
9668
9736
|
/**
|
|
@@ -9691,86 +9759,110 @@ declare type Payload<Success extends boolean = boolean, Data = any> = {
|
|
|
9691
9759
|
error?: Success extends false ? ErrorPlainObject | undefined : never;
|
|
9692
9760
|
};
|
|
9693
9761
|
|
|
9762
|
+
/**
|
|
9763
|
+
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
9764
|
+
*
|
|
9765
|
+
* @see {@link ByType}
|
|
9766
|
+
*
|
|
9767
|
+
* @typeParam Type String key specifying the event to extract
|
|
9768
|
+
*/
|
|
9769
|
+
declare type Payload_10<Type extends EventType_8> = BaseEvents.Payload<Event_11, Type>;
|
|
9770
|
+
|
|
9694
9771
|
/**
|
|
9695
9772
|
* Extracts a single event type matching the given key from the Layout DOM {@link Event} union.
|
|
9696
9773
|
*
|
|
9697
9774
|
* @typeParam Type String key specifying the event to extract
|
|
9698
9775
|
*/
|
|
9699
|
-
declare type
|
|
9776
|
+
declare type Payload_11<Type extends EventType_9> = Extract<Event_12, {
|
|
9700
9777
|
type: Type;
|
|
9701
9778
|
}>;
|
|
9702
9779
|
|
|
9780
|
+
/**
|
|
9781
|
+
* Extracts a single event type matching the given type key from the provided EmitterEvent union.
|
|
9782
|
+
*
|
|
9783
|
+
* @remarks Each event emitter namespace defines its own reduction of this type that fixes the Event parameter to
|
|
9784
|
+
* the appropriate payload union for that namespace.
|
|
9785
|
+
*
|
|
9786
|
+
* @typeParam Event Union of payloads for events on the given emitter
|
|
9787
|
+
* @see {@link ByType}
|
|
9788
|
+
*
|
|
9789
|
+
* @typeParam Type String key specifying the event to extract from the union
|
|
9790
|
+
*
|
|
9791
|
+
* @see {@link OpenFin.Events.ApplicationEvents.Payload}
|
|
9792
|
+
* @see {@link OpenFin.Events.ExternalApplicationEvents.Payload}
|
|
9793
|
+
* @see {@link OpenFin.Events.FrameEvents.Payload}
|
|
9794
|
+
* @see {@link OpenFin.Events.GlobalHotkeyEvents.Payload}
|
|
9795
|
+
* @see {@link OpenFin.Events.PlatformEvents.Payload}
|
|
9796
|
+
* @see {@link OpenFin.Events.SystemEvents.Payload}
|
|
9797
|
+
* @see {@link OpenFin.Events.ViewEvents.Payload}
|
|
9798
|
+
* @see {@link OpenFin.Events.WindowEvents.Payload}
|
|
9799
|
+
*/
|
|
9800
|
+
declare type Payload_2<Event extends BaseEvent, EventType extends string> = Extract<Event, {
|
|
9801
|
+
type: EventType;
|
|
9802
|
+
}>;
|
|
9803
|
+
|
|
9703
9804
|
/**
|
|
9704
9805
|
* Extracts a single event type matching the given key from the View {@link Event} union.
|
|
9705
9806
|
*
|
|
9807
|
+
* @see {@link ByType}
|
|
9808
|
+
*
|
|
9706
9809
|
* @typeParam Type String key specifying the event to extract
|
|
9707
9810
|
*/
|
|
9708
|
-
declare type
|
|
9709
|
-
type: Type;
|
|
9710
|
-
}>;
|
|
9811
|
+
declare type Payload_3<Type extends EventType> = BaseEvents.Payload<Event_4, Type>;
|
|
9711
9812
|
|
|
9712
9813
|
/**
|
|
9713
9814
|
* Extracts a single event type matching the given key from the Window {@link Event} union.
|
|
9714
9815
|
*
|
|
9816
|
+
* @see {@link ByType}
|
|
9817
|
+
*
|
|
9715
9818
|
* @typeParam Type String key specifying the event to extract
|
|
9716
9819
|
*/
|
|
9717
|
-
declare type
|
|
9718
|
-
type: Type;
|
|
9719
|
-
}>;
|
|
9820
|
+
declare type Payload_4<Type extends EventType_2> = BaseEvents.Payload<Event_6, Type>;
|
|
9720
9821
|
|
|
9721
9822
|
/**
|
|
9722
9823
|
* Extracts a single event type matching the given key from the Application {@link Event} union.
|
|
9723
9824
|
*
|
|
9825
|
+
* @see {@link ByType}
|
|
9826
|
+
*
|
|
9724
9827
|
* @typeParam Type String key specifying the event to extract
|
|
9725
9828
|
*/
|
|
9726
|
-
declare type
|
|
9727
|
-
type: Type;
|
|
9728
|
-
}>;
|
|
9829
|
+
declare type Payload_5<Type extends EventType_3> = BaseEvents.Payload<Event_3, Type>;
|
|
9729
9830
|
|
|
9730
9831
|
/**
|
|
9731
9832
|
* Extracts a single event type matching the given key from the ExternalApplication {@link Event} union.
|
|
9732
9833
|
*
|
|
9834
|
+
* @see {@link ByType}
|
|
9835
|
+
*
|
|
9733
9836
|
* @typeParam Type String key specifying the event to extract
|
|
9734
9837
|
*/
|
|
9735
|
-
declare type
|
|
9736
|
-
type: Type;
|
|
9737
|
-
}>;
|
|
9838
|
+
declare type Payload_6<Type extends EventType_4> = BaseEvents.Payload<Event_7, Type>;
|
|
9738
9839
|
|
|
9739
9840
|
/**
|
|
9740
9841
|
* Extracts a single event type matching the given key from the Frame {@link Event} union.
|
|
9741
9842
|
*
|
|
9843
|
+
* @see {@link ByType}
|
|
9844
|
+
*
|
|
9742
9845
|
* @typeParam Type String key specifying the event to extract
|
|
9743
9846
|
*/
|
|
9744
|
-
declare type
|
|
9745
|
-
type: Type;
|
|
9746
|
-
}>;
|
|
9847
|
+
declare type Payload_7<Type extends EventType_5> = BaseEvents.Payload<Event_8, Type>;
|
|
9747
9848
|
|
|
9748
9849
|
/**
|
|
9749
9850
|
* Extracts a single event type matching the given key from the GlobalHotkey {@link Event} union.
|
|
9750
9851
|
*
|
|
9852
|
+
* @see {@link ByType}
|
|
9853
|
+
*
|
|
9751
9854
|
* @typeParam Type String key specifying the event to extract
|
|
9752
9855
|
*/
|
|
9753
|
-
declare type
|
|
9754
|
-
type: Type;
|
|
9755
|
-
}>;
|
|
9856
|
+
declare type Payload_8<Type extends EventType_6> = BaseEvents.Payload<Event_9, Type>;
|
|
9756
9857
|
|
|
9757
9858
|
/**
|
|
9758
9859
|
* Extracts a single event type matching the given key from the Platform {@link Event} union.
|
|
9759
9860
|
*
|
|
9760
|
-
* @
|
|
9761
|
-
*/
|
|
9762
|
-
declare type Payload_8<Type extends EventType_7> = Extract<Event_10, {
|
|
9763
|
-
type: Type;
|
|
9764
|
-
}>;
|
|
9765
|
-
|
|
9766
|
-
/**
|
|
9767
|
-
* Extracts a single event type matching the given key from the System {@link Event} union.
|
|
9861
|
+
* @see {@link ByType}
|
|
9768
9862
|
*
|
|
9769
9863
|
* @typeParam Type String key specifying the event to extract
|
|
9770
9864
|
*/
|
|
9771
|
-
declare type Payload_9<Type extends
|
|
9772
|
-
type: Type;
|
|
9773
|
-
}>;
|
|
9865
|
+
declare type Payload_9<Type extends EventType_7> = BaseEvents.Payload<Event_10, Type>;
|
|
9774
9866
|
|
|
9775
9867
|
/**
|
|
9776
9868
|
* @interface
|
|
@@ -10495,7 +10587,7 @@ declare namespace PlatformEvents {
|
|
|
10495
10587
|
PlatformEvent,
|
|
10496
10588
|
EventType_7 as EventType,
|
|
10497
10589
|
PlatformEventType,
|
|
10498
|
-
|
|
10590
|
+
Payload_9 as Payload,
|
|
10499
10591
|
ByType_7 as ByType
|
|
10500
10592
|
}
|
|
10501
10593
|
}
|
|
@@ -11978,6 +12070,8 @@ declare interface ProtocolMap extends ProtocolMapBase {
|
|
|
11978
12070
|
};
|
|
11979
12071
|
response: void;
|
|
11980
12072
|
};
|
|
12073
|
+
'get-host-specs': GetterCall<OpenFin_2.HostSpecs>;
|
|
12074
|
+
'get-os-info': GetterCall<OpenFin_2.OSInfo>;
|
|
11981
12075
|
'system-get-printers': GetterCall<OpenFin_2.PrinterInfo[]>;
|
|
11982
12076
|
'system-register-shutdown-handler': VoidCall;
|
|
11983
12077
|
'get-domain-settings': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.DefaultDomainSettings>;
|
|
@@ -12834,7 +12928,7 @@ declare type Snapshot = {
|
|
|
12834
12928
|
* _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.
|
|
12835
12929
|
* @interface
|
|
12836
12930
|
*/
|
|
12837
|
-
declare type SnapshotAppliedEvent = BaseEvent & {
|
|
12931
|
+
declare type SnapshotAppliedEvent = BaseEvents.BaseEvent & {
|
|
12838
12932
|
topic: 'application';
|
|
12839
12933
|
type: 'platform-snapshot-applied';
|
|
12840
12934
|
};
|
|
@@ -13324,7 +13418,8 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13324
13418
|
*/
|
|
13325
13419
|
getRvmInfo(): Promise<OpenFin_2.RVMInfo>;
|
|
13326
13420
|
/**
|
|
13327
|
-
* Retrieves system information.
|
|
13421
|
+
* Retrieves general system information. If you need more detailed information about the
|
|
13422
|
+
* OS and the currently logged in user, use `fin.System.getOSInfo()` instead.
|
|
13328
13423
|
*
|
|
13329
13424
|
* @example
|
|
13330
13425
|
* ```js
|
|
@@ -13332,6 +13427,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
|
|
|
13332
13427
|
* ```
|
|
13333
13428
|
*/
|
|
13334
13429
|
getHostSpecs(): Promise<OpenFin_2.HostSpecs>;
|
|
13430
|
+
/**
|
|
13431
|
+
* Retrieves information about the OS and the currently logged in user.
|
|
13432
|
+
*
|
|
13433
|
+
* @example
|
|
13434
|
+
* ```js
|
|
13435
|
+
* fin.System.getOSInfo().then(specs => console.log(specs)).catch(err => console.log(err));
|
|
13436
|
+
* ```
|
|
13437
|
+
*/
|
|
13438
|
+
getOSInfo(): Promise<OpenFin_2.OSInfo>;
|
|
13335
13439
|
/**
|
|
13336
13440
|
* Runs an executable or batch file. A path to the file must be included in options.
|
|
13337
13441
|
* <br> A uuid may be optionally provided. If not provided, OpenFin will create a uuid for the new process.
|
|
@@ -14445,7 +14549,7 @@ declare namespace SystemEvents {
|
|
|
14445
14549
|
SystemEvent,
|
|
14446
14550
|
EventType_8 as EventType,
|
|
14447
14551
|
SystemEventType,
|
|
14448
|
-
|
|
14552
|
+
Payload_10 as Payload,
|
|
14449
14553
|
ByType_8 as ByType
|
|
14450
14554
|
}
|
|
14451
14555
|
}
|
|
@@ -14459,6 +14563,7 @@ declare type SystemEventType = EventType_8;
|
|
|
14459
14563
|
* @interface
|
|
14460
14564
|
*/
|
|
14461
14565
|
declare type SystemPermissions = {
|
|
14566
|
+
getOSInfo: boolean;
|
|
14462
14567
|
getAllExternalWindows: boolean;
|
|
14463
14568
|
launchExternalProcess: boolean | {
|
|
14464
14569
|
enabled: boolean;
|
|
@@ -15510,7 +15615,7 @@ declare namespace ViewEvents {
|
|
|
15510
15615
|
PropagatedViewEvent,
|
|
15511
15616
|
PropagatedEventType_2 as PropagatedEventType,
|
|
15512
15617
|
PropagatedViewEventType,
|
|
15513
|
-
|
|
15618
|
+
Payload_3 as Payload,
|
|
15514
15619
|
ByType
|
|
15515
15620
|
}
|
|
15516
15621
|
}
|
|
@@ -18034,7 +18139,7 @@ declare namespace WindowEvents {
|
|
|
18034
18139
|
PropagatedEvent_3 as PropagatedEvent,
|
|
18035
18140
|
PropagatedWindowEvent,
|
|
18036
18141
|
PropagatedWindowEventType,
|
|
18037
|
-
|
|
18142
|
+
Payload_4 as Payload,
|
|
18038
18143
|
ByType_2 as ByType
|
|
18039
18144
|
}
|
|
18040
18145
|
}
|
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.
|